Skip to content

Commit f5d4931

Browse files
spawn08spawn08
committed
Revise documentation and installation instructions for Chronos framework
- Updated README.md to streamline installation instructions and enhance clarity. - Added a new CLI installation guide detailing the use of the install script for quick setup across platforms. - Improved navigation in the documentation to include new sections for CLI install, examples, and architecture. - Enhanced existing guides on quickstart, hooks, and multi-agent teams for better user guidance. - Introduced new markdown files for examples and observability, providing comprehensive insights into Chronos features.
1 parent 96df606 commit f5d4931

12 files changed

Lines changed: 342 additions & 869 deletions

File tree

‎README.md‎

Lines changed: 95 additions & 845 deletions
Large diffs are not rendered by default.

‎docs/_data/navigation.yml‎

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ docs:
55
url: /
66
- title: "Installation"
77
url: /getting-started/installation/
8+
- title: "CLI Install (curl)"
9+
url: /getting-started/cli-install/
810
- title: "Quickstart"
911
url: /getting-started/quickstart/
1012
- title: "Configuration"
@@ -24,15 +26,15 @@ docs:
2426
url: /guides/context-management/
2527
- title: "Multi-Agent Teams"
2628
url: /guides/teams/
27-
- title: "YAML Agent Examples"
28-
url: /guides/yaml-examples/
2929
- title: "StateGraph Runtime"
3030
url: /guides/stategraph/
3131

3232
- title: "Middleware"
3333
children:
3434
- title: "Overview"
3535
url: /guides/middleware/
36+
- title: "Hooks & Observability"
37+
url: /guides/hooks/
3638
- title: "Guardrails"
3739
url: /guides/guardrails/
3840
- title: "Cost Tracking"
@@ -45,6 +47,13 @@ docs:
4547
- title: "Streaming & SSE"
4648
url: /guides/streaming/
4749

50+
- title: "Examples"
51+
children:
52+
- title: "All Examples"
53+
url: /guides/examples/
54+
- title: "YAML Agent Examples"
55+
url: /guides/yaml-examples/
56+
4857
- title: "Deployment"
4958
children:
5059
- title: "Docker"
@@ -54,6 +63,15 @@ docs:
5463
- title: "CI/CD"
5564
url: /deployment/cicd/
5665

66+
- title: "Reference"
67+
children:
68+
- title: "Architecture"
69+
url: /reference/architecture/
70+
- title: "Model Providers"
71+
url: /reference/providers/
72+
- title: "Storage"
73+
url: /reference/storage/
74+
5775
- title: "API Reference"
5876
children:
5977
- title: "Interfaces"

‎docs/getting-started/cli-install.md‎

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
---
2+
title: "CLI Install"
3+
permalink: /getting-started/cli-install/
4+
sidebar:
5+
nav: "docs"
6+
---
7+
8+
# Install Chronos CLI
9+
10+
Pre-built binaries are published to [GitHub Releases](https://github.com/spawn08/chronos/releases) for every tagged version.
11+
12+
## Quick Install (Linux / macOS)
13+
14+
```bash
15+
curl -fsSL https://raw.githubusercontent.com/spawn08/chronos/main/install.sh | bash
16+
```
17+
18+
This auto-detects your OS and architecture, downloads the latest release, verifies the SHA-256 checksum, and installs to `/usr/local/bin`.
19+
20+
### Install a specific version
21+
22+
```bash
23+
curl -fsSL https://raw.githubusercontent.com/spawn08/chronos/main/install.sh | bash -s -- v1.0.0
24+
```
25+
26+
### Install to a custom directory
27+
28+
```bash
29+
curl -fsSL https://raw.githubusercontent.com/spawn08/chronos/main/install.sh | bash -s -- --dir ~/bin
30+
```
31+
32+
Or set the `INSTALL_DIR` environment variable:
33+
34+
```bash
35+
INSTALL_DIR=~/bin curl -fsSL https://raw.githubusercontent.com/spawn08/chronos/main/install.sh | bash
36+
```
37+
38+
## Supported Platforms
39+
40+
| Platform | Architecture | Binary |
41+
|----------|-------------|--------|
42+
| **Linux** | x86_64 (amd64) | `chronos-linux-amd64` |
43+
| **Linux** | ARM64 | `chronos-linux-arm64` |
44+
| **macOS** | Intel (x86_64) | `chronos-darwin-amd64` |
45+
| **macOS** | Apple Silicon (M1/M2/M3/M4) | `chronos-darwin-arm64` |
46+
| **Windows** | x86_64 | `chronos-windows-amd64.exe` |
47+
| **Windows** | ARM64 | `chronos-windows-arm64.exe` |
48+
49+
All binaries are statically linked (`CGO_ENABLED=0`) and require no external dependencies.
50+
51+
## Manual Download
52+
53+
Download the binary for your platform from the [latest release](https://github.com/spawn08/chronos/releases/latest):
54+
55+
### Linux / macOS
56+
57+
```bash
58+
# Download (replace OS and ARCH as needed)
59+
curl -fSL -o chronos.tar.gz \
60+
https://github.com/spawn08/chronos/releases/latest/download/chronos-v0.1.0-linux-amd64.tar.gz
61+
62+
# Extract
63+
tar xzf chronos.tar.gz
64+
65+
# Install
66+
sudo mv chronos-linux-amd64 /usr/local/bin/chronos
67+
chmod +x /usr/local/bin/chronos
68+
```
69+
70+
### Windows
71+
72+
1. Download the `.zip` from [Releases](https://github.com/spawn08/chronos/releases/latest)
73+
2. Extract `chronos-windows-amd64.exe`
74+
3. Move it to a directory in your `PATH` or add its location to `PATH`
75+
76+
## Verify Installation
77+
78+
```bash
79+
chronos version
80+
```
81+
82+
Expected output:
83+
84+
```
85+
chronos v0.1.0
86+
commit: abc1234
87+
built: 2026-03-23T00:00:00Z
88+
go: go1.24.11
89+
os/arch: linux/amd64
90+
```
91+
92+
## Verify Checksum
93+
94+
Each release includes a `checksums-sha256.txt` file:
95+
96+
```bash
97+
# Download checksums
98+
curl -fSL -o checksums.txt \
99+
https://github.com/spawn08/chronos/releases/latest/download/checksums-sha256.txt
100+
101+
# Verify
102+
sha256sum -c checksums.txt
103+
```
104+
105+
## Using as a Go Library
106+
107+
If you want to use Chronos as a Go library rather than a CLI tool:
108+
109+
```bash
110+
go get github.com/spawn08/chronos
111+
```
112+
113+
See the [Quickstart]({{ '/getting-started/quickstart/' | relative_url }}) for usage examples.
114+
115+
## Build from Source
116+
117+
```bash
118+
git clone https://github.com/spawn08/chronos.git
119+
cd chronos
120+
make build # outputs to bin/chronos
121+
```
122+
123+
Or directly:
124+
125+
```bash
126+
go build -o chronos ./cli/main.go
127+
```
128+
129+
## Updating
130+
131+
Re-run the install script to get the latest version:
132+
133+
```bash
134+
curl -fsSL https://raw.githubusercontent.com/spawn08/chronos/main/install.sh | bash
135+
```
136+
137+
## Uninstall
138+
139+
```bash
140+
sudo rm /usr/local/bin/chronos
141+
```

‎docs/getting-started/installation.md‎

Lines changed: 34 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,62 @@
1+
---
2+
title: "Installation"
3+
permalink: /getting-started/installation/
4+
sidebar:
5+
nav: "docs"
6+
---
7+
18
# Installation
29

3-
## Requirements
10+
## Option 1: Install CLI (recommended)
411

5-
- **Go 1.24+** — [Download Go](https://go.dev/dl/)
6-
- **C compiler** — Required for SQLite via CGO (gcc on Linux, Xcode Command Line Tools on macOS)
12+
Pre-built binaries for Linux, macOS, and Windows:
713

8-
## Install as a Go Module
14+
```bash
15+
curl -fsSL https://raw.githubusercontent.com/spawn08/chronos/main/install.sh | bash
16+
```
917

10-
Add Chronos to your project:
18+
Verify:
1119

1220
```bash
13-
go get github.com/spawn08/chronos
21+
chronos version
1422
```
1523

16-
## Build from Source
24+
See [CLI Install]({{ '/getting-started/cli-install/' | relative_url }}) for platform-specific details and manual download options.
25+
26+
## Option 2: Go Module
27+
28+
Add Chronos as a library to your Go project:
1729

1830
```bash
19-
git clone https://github.com/spawn08/chronos.git
20-
cd chronos
21-
go build ./...
31+
go get github.com/spawn08/chronos
2232
```
2333

24-
## Verify Installation
34+
**Requirements:** Go 1.24+, C compiler (for SQLite via CGO).
2535

26-
Run the quickstart example (no API keys needed):
36+
## Option 3: Build from Source
2737

2838
```bash
29-
go run ./examples/quickstart/
39+
git clone https://github.com/spawn08/chronos.git
40+
cd chronos
41+
make build # outputs to bin/chronos
3042
```
3143

32-
Expected output:
44+
Or directly:
3345

34-
```
35-
Result: map[greeting:Hello, World! intent:general_question response:I classified your intent as "general_question". How can I help? user:World]
46+
```bash
47+
go build -o chronos ./cli/main.go
48+
./chronos version
3649
```
3750

38-
## CLI Binary
51+
## Verify
3952

40-
Build the CLI for interactive use:
53+
Run the quickstart example (no API keys needed):
4154

4255
```bash
43-
go build -o bin/chronos ./cli/main.go
44-
./bin/chronos version
56+
go run ./examples/quickstart/
4557
```
4658

4759
## Next Steps
4860

49-
- [Quickstart Guide](quickstart.md) — Build your first agent
50-
- [Examples](../guides/examples.md) — Browse all runnable examples
61+
- [Quickstart]({{ '/getting-started/quickstart/' | relative_url }}) — Build your first agent
62+
- [Examples]({{ '/guides/examples/' | relative_url }}) — Browse all runnable examples

‎docs/getting-started/quickstart.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: "Quickstart"
3+
permalink: /getting-started/quickstart/
4+
sidebar:
5+
nav: "docs"
6+
---
7+
18
# Quickstart
29

310
This guide walks you through building your first Chronos agent in under 5 minutes. No API keys required.

‎docs/guides/examples.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: "Examples"
3+
permalink: /guides/examples/
4+
sidebar:
5+
nav: "docs"
6+
---
7+
18
# Examples Guide
29

310
Chronos ships with 12+ runnable examples covering every major feature. Most require **no API keys** and run entirely with mock providers and SQLite.

‎docs/guides/hooks.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: "Hooks & Observability"
3+
permalink: /guides/hooks/
4+
sidebar:
5+
nav: "docs"
6+
---
7+
18
# Hooks & Observability
29

310
Hooks are middleware that intercept model calls, tool calls, and session events. They provide a composable way to add caching, retry logic, cost tracking, rate limiting, metrics, and logging without modifying agent code.

‎docs/guides/teams.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: "Multi-Agent Teams"
3+
permalink: /guides/teams/
4+
sidebar:
5+
nav: "docs"
6+
---
7+
18
# Multi-Agent Teams
29

310
Chronos supports four team orchestration strategies for composing agents into collaborative workflows.

‎docs/index.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ classes: wide
2121
</a>
2222
</div>
2323
<div class="install-command">
24+
<span class="prompt">$ </span>curl -fsSL https://raw.githubusercontent.com/spawn08/chronos/main/install.sh | bash
25+
</div>
26+
<div class="install-command" style="margin-top: 0.5rem; font-size: 0.85em; opacity: 0.8;">
2427
<span class="prompt">$ </span>go get github.com/spawn08/chronos
2528
</div>
2629
</div>

‎docs/reference/architecture.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: "Architecture"
3+
permalink: /reference/architecture/
4+
sidebar:
5+
nav: "docs"
6+
---
7+
18
# Architecture
29

310
Chronos is organized into four layers, each with clear responsibilities and boundaries.

0 commit comments

Comments
 (0)