The Brightsy Command Line Interface (CLI) provides a powerful way to interact with Brightsy AI directly from your terminal, enabling streamlined workflows and integration options.
Installation
Install the Brightsy CLI globally using npm:
npm install -g brightsy-cli
Or run it directly with npx:
npx brightsy-cli
Configuration
Before using the CLI, you need to set up your API key and agent ID:
brightsy configure <agent_id> <api_key>
Additional Configuration Options
View current configuration
brightsy configure --view
Reset configuration
brightsy configure --reset
Chat Functionality
The CLI allows you to have conversations with your Brightsy AI agent directly from the terminal.
Starting or Continuing a Chat
To start a new chat or continue the active chat:
brightsy "Your message here"
Chat Management
Continue a specific chat
brightsy chat "Your message here" --chat-id <chat-id>
Note: The
--chat-idparameter 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 Model Context Protocol (MCP) server functionality, allowing you to integrate Brightsy AI with compatible applications like Cursor and Claude Desktop.
Running the MCP Server
Start the MCP server directly:
brightsy mcp
For detailed information on MCP integration, see the MCP documentation.
Use Cases
Development Workflows
- Quick Information Retrieval: Get answers without leaving your terminal
- Code Generation: Generate code snippets directly in your workflow
- Project Management: Track tasks and issues through conversations
Automation
- CI/CD Integration: Include Brightsy AI in your automated workflows
- Scheduled Tasks: Set up cron jobs that interact with Brightsy AI