Skip to main content
Get Arka running on macOS, Linux, or Windows — no git clone or local build required. Install the published Python package, run arka setup, add an API key, and use arka from any terminal.
At a glance: Requires Python 3.11+, one LLM API key (Gemini or Groq recommended), and optionally fish shell for the full skill router. Recommended install: pipx install "arka-agent[chat]"arka setuparka doctorarka ask "what is Rust?". Full docs: Introduction.
Watch the quickstart tutorial:

Arka quickstart — install, configure, and run your first command

Recommended path — pipx (or pip) install, then verify and ask:

Before you begin

Arka uses a docs-as-code approach — this site is built on Mintlify and deployed at arka-agent.mintlify.site. To use Arka itself, you need:
  • Python 3.11+
  • At least one LLM API key (Gemini or Groq recommended for free tiers)
  • fish shell for the full 70+ skill router (optional but recommended)

Install (no build from source)

Most users should install the arka-agent package directly. You do not need to clone the repo, run ./scripts/refetch.sh, or compile anything — pip / pipx downloads a ready-to-run CLI.
After install, which arka should print a path under pipx’s venv or your active Python environment. Run arka doctor — you should see Skills: full (70+) when fish is installed, or portable mode otherwise.

Use Arka from any terminal

Once installed, open a new terminal tab (so PATH picks up pipx) and run:
Optional — unlock the full 70+ skill router with fish shell:
Without fish, Arka still works in portable mode: arka ask, calc, weather, plugins, and MCP.

Get started

1

Configure API keys

Copy the example env file and add at least one provider key.
Minimum .env for a quick start:
Config paths vary by OS. Linux uses ~/.config/arka/, macOS uses ~/Library/Application Support/arka/, and Windows uses %APPDATA%\arka\.
2

Verify the install

Run diagnostics to confirm dependencies and API keys.
3

Run your first command

Ask a question and see Arka route it to the web answer skill.
Try a few more:
4

Personalize (optional)

Pick interests and get skill recommendations tailored to you.
See Personalize your Arka experience for interest tags and non-interactive flags.
5

Install fish shell (optional)

Fish unlocks the full 70+ skill router. The pip package ships config.fish.

Optional extras

Next steps

Follow the sidebar in order, or jump to what you need:

How to code with Arka

Daily coding workflow — setup, edits, review, CI, and Cursor MCP.

CLI reference

All commands, aliases, and subcommands.

Skills catalog

What you can ask Arka to do.

How routing works

Offline rules, LLM fallback, and correction layer.

LLM configuration

Providers, failover, and per-skill models.

Configuration

Env vars, precedence, and built-in defaults.

Voice

Wake word, STT, and TTS setup.

Arka Council

Multi-persona deliberation.

Changelog

What’s new this week.