Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,49 @@ kortex-cli is a command-line interface for launching and managing AI agents with
- Integrate with various LLM providers
- Consistent interface across different agent types

## Getting Started

### Prerequisites

- Go 1.25+
- Make

### Build

```bash
make build
```

This creates the `kortex-cli` binary in the current directory.

### Run

```bash
# Display help and available commands
./kortex-cli --help

# Execute a specific command
./kortex-cli <command> [flags]
```

### Install

To install the binary to your `GOPATH/bin` for system-wide access:

```bash
make install
```

### Run Tests

```bash
# Run all tests
make test

# Run tests with coverage report
make test-coverage
```

## Glossary

### Agent
Expand Down
Loading