Servemyapi

🚀 ServeMyAPI

A personalized tool for securely storing and accessing cross - project API keys via the macOS Keychain.

🚀 Quick Start

ServeMyAPI is a tool that helps developers securely manage and access their API keys through the macOS Keychain. It allows users to store sensitive information in a system - level security facility, thus avoiding hard - coding it into the code repository or keeping it in plain text in configuration files. Different from traditional .env files, ServeMyAPI provides a more secure and unified way to manage credentials across all development environments.

✨ Features

1. Addressing Security Risks of Traditional .env Files

• Preventing Credentials from Being Committed to Version Control
  Developers often accidentally commit .env files containing sensitive information to the code repository, leading to security vulnerabilities. ServeMyAPI is designed to avoid this problem as it never stores keys in the file system.
• Cross - Project Consistency
  Each project has its own .env file, which can lead to scattered credentials and management chaos. With ServeMyAPI, all projects can share the same secure storage location for managing API keys.

2. Enhanced Security

• System - Level Encryption
  The macOS Keychain uses proven encryption protocols to protect keys, ensuring that even if the device is physically accessed, unauthorized users cannot decrypt sensitive information.
• Authentication Requirement
  Accessing data in the Keychain requires the user's explicit authorization, providing an additional layer of security in the development environment.

Security Storage and Access

• Encrypted Storage: All API keys are stored in the macOS Keychain using industry - standard encryption protocols.
• Permission Control: Only authenticated users can access the stored keys, preventing unauthorized use.

Convenient CLI Tool

ServeMyAPI provides an easy - to - use command - line interface (CLI) that supports the following operations:

1. Store API Key

serve-my-api store --name <KEY_NAME> --key <API_KEY>

• Parameters:
  • --name: The unique identifier for the key, used for subsequent access.
  • --key: The actual API key to be stored.

2. Retrieve API Key

serve-my-api get --name <KEY_NAME>

• Parameters:
  • --name: The identifier of the key to be retrieved.

3. Delete API Key

serve-my-api delete --name <KEY_NAME>

• Parameters:
  • --name: The identifier of the key to be deleted.

4. List All Stored Keys

serve-my-api list

📦 Installation

Global Installation (Recommended)

npm install -g serve-my-api

Local Development Environment Installation

To use it in a specific project, you can install it as a development dependency:

npm install --save-dev serve-my-api

💻 Usage Examples

Basic Usage

1. Store a Key

serve-my-api store --name openai-key --key sk-your-key-here

2. Retrieve a Key

serve-my-api get --name openai-key  # Returns: sk-your-key-here

3. Delete a Key

serve-my-api delete --name openai-key

4. List All Keys

serve-my-api list  # Output example:
# [
#   { name: 'openai-key', exists: true },
#   { name: 'stripe-key', exists: true }
# ]

Advanced Usage

1. Integrate into CI/CD Pipeline

You can use ServeMyAPI to securely inject API keys during the build process:

serve-my-api get --name openai-key | xargs npm run-script build

2. Automatically Load Keys

By configuring scaffolding tools or frameworks, you can achieve automatic support for ServeMyAPI. For example, add the following to package.json:

{
  "scripts": {
    "start": "serve-my-api get --name openai-key | node server.js"
  }
}

📚 Documentation

Security Precautions

• Encrypted Storage: All keys are encrypted via the macOS Keychain, ensuring data security.
• Access Control: Only authenticated users can access the contents in the Keychain.
• No Plain - Text Storage: ServeMyAPI never stores keys in plain text in the file system.

Frequently Asked Questions

Q: How can I ensure the security of my keys?

A: ServeMyAPI uses the native Keychain service of macOS, which is a rigorously tested and verified security mechanism. As long as you properly manage your system password, you can ensure data security.

Q: Which platforms are supported?

A: Currently, ServeMyAPI only supports the macOS system. Support for Windows and Linux is under development.

Q: Can I use it in a production environment?

A: It is not recommended to use ServeMyAPI directly in a production environment, as it would make the build process dependent on local credentials. It is advisable to integrate sensitive information management into a more professional secret management system (such as HashiCorp Vault).

🔧 Technical Details

If you wish to participate in project development or submit feature requests, please visit our GitHub repository.

📄 License

ServeMyAPI is an open - source project licensed under the MIT License. Please refer to the LICENSE file for specific license information.