Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Quickstart

This guide gets a working Akshi runtime running in about five minutes. You should already have the akshi CLI installed (see Installation).

1. Scaffold and start

akshi quickstart

This single command:

  • Creates a default runtime.toml configuration in the current directory.
  • Builds a sample agent to WebAssembly.
  • Starts the runtime with that agent loaded.

You will see log output as the runtime boots and the agent begins executing.

2. Open the dashboard

While the runtime is running, open the web dashboard:

http://127.0.0.1:3210

The dashboard shows agent status, inference routing decisions, and live log output.

3. Check status

In a separate terminal:

akshi status

This prints the state of the runtime and each loaded agent (running, idle, errored).

4. View logs

Stream runtime and agent logs:

akshi logs -f

Press Ctrl-C to stop following.

5. Stop the runtime

akshi stop

This gracefully shuts down all agents and the runtime process.

What just happened

The quickstart command created a minimal setup with:

  • A runtime.toml with a declarative agent configuration — goal, file pattern, LLM prompt, and output schema are all defined in TOML.
  • A pre-built agent Wasm module that reads the declarative config and handles file watching, inference calls, and result storage automatically.

No Rust toolchain or custom code was needed. The agent behavior is entirely driven by the TOML configuration.

To understand each piece in detail, continue to Your First Agent where you configure an agent from scratch.