@embedapi/cli

1.0.8 • Public • Published

@embedapi/cli

The official command-line interface for EmbedAPI services. Experience real-time streaming responses from various AI models directly in your terminal.

Installation & Updates

Install globally:

npm install -g @embedapi/cli

Stay up to date with the latest features:

npm update -g @embedapi/cli

Check your current version:

embedapi --version

Prerequisites

  1. Create an Account: Sign up at embedapi.com
  2. Get API Key: Generate your API key from the dashboard
  3. Add Credits: Fund your account with credits to start using the services
    • Visit embedapi.com/billing
    • Add credits using your preferred payment method
    • Start with as little as $5 to try out the service

Quick Start

# Set your encryption passphrase
export EMBEDAPI_SECRET_PASSPHRASE="your-secure-passphrase"

# Start the CLI
embedapi

On first run, you'll be prompted for your API key. This will be securely encrypted and stored locally.

Features

  • Real-time Streaming: See AI responses as they're being generated, word by word
  • Multiple AI Services: Support for OpenAI, Anthropic, VertexAI, and more
  • Secure Storage: Military-grade encryption (AES-256-CBC) for API credentials
  • Conversation Memory: Maintains context for more natural conversations
  • Service Switching: Seamlessly switch between different AI providers and models

Commands

During an interactive session, the following commands are available:

Command Shorthand Description
$switch-model <service> <model> $sm Switch AI service/model
$list-models $ll List available models
exit or quit - Exit the CLI

Examples

Switch to Claude 3:

$switch-model anthropic claude-3

List Available Models:

$list-models

Chat with AI: Simply type your message and press enter. The response will stream in real-time:

> Tell me about quantum computing
AI: Quantum computing is a form of computing that harnesses...

Security

Your API key is protected using:

  • AES-256-CBC encryption with random initialization vectors (IV)
  • Restricted file permissions (600)
  • Local storage in your home directory
  • Environment variable based encryption key

Configuration

The CLI stores configuration in your home directory:

  • .embedapi_key: Encrypted API key storage
  • Required environment variable: EMBEDAPI_SECRET_PASSPHRASE for key encryption

Environment Variables

EMBEDAPI_SECRET_PASSPHRASE  # Required: Passphrase for API key encryption
EMBEDAPI_DEBUG=true         # Optional: Enable debug logging

Streaming Behavior

  • Real-time response streaming
  • Word-by-word output as content is generated
  • Maintains conversation context automatically
  • Supports markdown rendering in terminal
  • Shows typing indicators during processing

Troubleshooting

Reset API Key

rm ~/.embedapi_key

Common Issues

  • Missing EMBEDAPI_SECRET_PASSPHRASE: Set this environment variable
  • Connection Issues: Check internet and API key validity
  • Model Availability: Verify selected model is available
  • Credit Balance: Ensure sufficient credits in account
  • Version Issues: Make sure you're running the latest version

Version Conflicts

If you experience issues, try reinstalling the latest version:

npm uninstall -g @embedapi/cli
npm install -g @embedapi/cli

Support

License

MIT License - see LICENSE for details.

Readme

Keywords

Package Sidebar

Install

npm i @embedapi/cli

Weekly Downloads

6

Version

1.0.8

License

MIT

Unpacked Size

11.6 kB

Total Files

3

Last publish

Collaborators

  • embedapi.com