Brightsy CLI

A command-line interface for interacting with Brightsy AI.

Installation

Install the Brightsy CLI globally using npm:

npm install -g brightsy-cli

Or run it directly with npx:

npx brightsy-cli

Usage

Before using the CLI, ensure you have set up your API key and agent ID. You can do this in several ways:

Configuration

• Configure both API Key and Agent ID (and clear chat history)

  brightsy configure <agent_id> <api_key>

• View current configuration

  brightsy configure --view

• Reset configuration

  brightsy configure --reset

Chat Commands

• Start a new chat or continue the active chat

  brightsy "Your message here"

• Continue a specific chat

  brightsy chat "Your message here" --chat-id <chat-id>

  Note: The --chat-id parameter is optional. If omitted, the command will use the active chat.

• End the current chat session

  brightsy chat --end

• List recent chats

  brightsy chat --list

MCP Integration

The Brightsy CLI includes MCP (Model Control Protocol) server functionality, allowing you to integrate Brightsy AI with compatible applications like Cursor and Claude Desktop.

• Start MCP server directly

  brightsy mcp

• Add to Cursor or Claude Desktop

  Register Brightsy as an MCP server with the following configuration:

  {
    "mcpServers": {
      "Brightsy": {
        "command": "npx",
        "args": [
          "-y",
          "brightsy-mcp",
          "--agent-id=YOUR_AGENT_ID",
          "--api-key=YOUR_API_KEY",
          "--tool-name=Brightsy AI"
        ]
      }
    }
  }

  Replace YOUR_AGENT_ID and YOUR_API_KEY with your actual credentials.

Development

To start the CLI in development mode, use:

npm run dev

To build the project, use:

npm run build

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

License

This project is licensed under the MIT License.