|
| 1 | +# Vertesia Agent CLI |
| 2 | + |
| 3 | +A command-line interface for interacting with Vertesia's AI agents. This CLI allows you to run conversations with Vertesia agents directly from your terminal. |
| 4 | + |
| 5 | +## Installation |
| 6 | + |
| 7 | +### From Source |
| 8 | + |
| 9 | +1. Clone the repository |
| 10 | +2. Install dependencies: |
| 11 | + |
| 12 | + ```bash |
| 13 | + npm install |
| 14 | + ``` |
| 15 | + |
| 16 | +3. Build the project: |
| 17 | + |
| 18 | + ```bash |
| 19 | + npm run build |
| 20 | + ``` |
| 21 | + |
| 22 | +4. Link the CLI to make it available globally: |
| 23 | + |
| 24 | + ```bash |
| 25 | + npm link |
| 26 | + ``` |
| 27 | + |
| 28 | +## Configuration |
| 29 | + |
| 30 | +Create a `.env` file in the project root with the following variables: |
| 31 | + |
| 32 | +```env |
| 33 | +VERTESIA_API_KEY=<your_vertesia_api_key> |
| 34 | +``` |
| 35 | + |
| 36 | +## Usage |
| 37 | + |
| 38 | +### Getting Help |
| 39 | + |
| 40 | +```bash |
| 41 | +agent --help |
| 42 | +``` |
| 43 | + |
| 44 | +### Running a Simple Agent Conversation |
| 45 | + |
| 46 | +```bash |
| 47 | +agent run "Generate 5 creative business ideas for a tech startup and store those as individual content objects in a collection" |
| 48 | +``` |
| 49 | + |
| 50 | +### Running an Interactive Conversation |
| 51 | + |
| 52 | +```bash |
| 53 | +agent run "Help me debug my React application" --interactive |
| 54 | +``` |
| 55 | + |
| 56 | +### Specifying Agent Type |
| 57 | + |
| 58 | +```bash |
| 59 | +agent run "Create a marketing plan" --agent MarketingAgent |
| 60 | +``` |
| 61 | + |
| 62 | +## Command Options |
| 63 | + |
| 64 | +- `--interactive`, `-i`: Enable interactive mode where you can converse with the agent |
| 65 | +- `--agent`, `-a`: Specify the agent type to use (default: MultipurposeAgent) |
| 66 | + |
| 67 | +## Features |
| 68 | + |
| 69 | +- Markdown rendering: Agent responses are rendered as markdown in the terminal |
| 70 | +- Interactive mode: Have real-time conversations with agents |
| 71 | +- Configurable agent types: Use different specialized agents for different tasks |
| 72 | +- Color-coded messages: Easily distinguish between user and agent messages |
| 73 | +- Link transformation: Resource references like `store:abc123` and `collection:xyz789` are automatically converted to clickable URLs |
| 74 | +- Styled hyperlinks: Links appear with white text and underline for better visibility |
| 75 | + |
| 76 | +## Development |
| 77 | + |
| 78 | +- Run in development mode: `npm run dev` |
| 79 | +- Build the project: `npm run build` |
| 80 | +- Run linting: `npm run lint` |
| 81 | +- Format code: `npm run format` |
| 82 | + |
| 83 | +## License |
| 84 | + |
| 85 | +APL-2.0 © Vertesia |
0 commit comments