From fa2128bf6734409e7ed0eff593162cfe7f375650 Mon Sep 17 00:00:00 2001 From: Brian Date: Fri, 27 Mar 2026 02:21:38 -0400 Subject: [PATCH] docs(readme): add Getting Started section with build and run instructions Co-Authored-By: Claude Opus 4.6 (1M context) Signed-off-by: Brian --- README.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/README.md b/README.md index 05e34e1..49d1dca 100644 --- a/README.md +++ b/README.md @@ -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 [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