You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Atomic Agent is an open-source, local-first AI agent that runs on your computer. It plans multi-step tasks and executes them with real tools: shell, files, browser automation, skills, and MCP servers. All agent state, memory, and configuration live on your machine in `~/.atomic-agent`.
@@ -24,43 +22,75 @@ Atomic Agent is MIT-licensed and available for macOS, Linux, and Windows.
24
22
* Telegram connector and an OpenAI-compatible local HTTP server
25
23
* MIT license, installs without an account
26
24
25
+
## Prerequisites
26
+
27
+
* An AIMLAPI key obtained from your [account dashboard](https://aimlapi.com/app/keys)
28
+
27
29
***
28
30
29
-
## Quick Install
31
+
{% stepper %}
32
+
{% step %}
33
+
### Step 1 — Install Atomic Agent
30
34
31
-
One command, no account or key required:
35
+
One command, no account or key required.
32
36
33
-
```sh
34
-
# macOS / Linux
37
+
macOS / Linux:
38
+
39
+
```bash
35
40
curl -fsSL https://atomicagent.io/install | sh
36
41
```
37
42
43
+
Windows:
44
+
38
45
```powershell
39
-
# Windows
40
46
irm https://atomicagent.io/install.ps1 | iex
41
47
```
48
+
{% endstep %}
42
49
43
-
***
50
+
{% step %}
51
+
### Step 2 — Open the Provider Panel
52
+
53
+
Launch the TUI and open the LLM Local/Cloud panel:
54
+
55
+
```bash
56
+
atomic-agent tui
57
+
```
58
+
59
+
Then type:
60
+
61
+
```
62
+
/model
63
+
```
64
+
{% endstep %}
44
65
45
-
## Configuration
66
+
{% step %}
67
+
### Step 3 — Connect AI/ML API
46
68
47
-
You will need an AIMLAPI key from your [account dashboard](https://aimlapi.com/app/keys).
69
+
Select **AI/ML API (aimlapi.com — 500+ models, OpenAI-compatible)**from the provider list and paste your API key when prompted.
The wizard stores the key as `AIMLAPI_API_KEY` in `~/.atomic-agent/.env` and writes the provider entry to `~/.atomic-agent/config.json`. The base URL is built into the provider, so there is nothing else to configure.
72
+
{% endstep %}
50
73
51
-
Atomic Agent ships with a native AI/ML API provider, so there is nothing to configure by hand.
74
+
{% step %}
75
+
### Step 4 — Pick a Model
52
76
53
-
1. Run `atomic-agent tui`.
54
-
2. Type `/model` to open the LLM Local/Cloud panel.
55
-
3. Select **AI/ML API (aimlapi.com — 500+ models, OpenAI-compatible)**.
56
-
4. Paste your API key when prompted.
57
-
5. Pick a chat model. The list is fetched live from the AI/ML API, so new models appear as soon as they are released.
77
+
Choose a chat model from the list. Atomic Agent fetches the current model catalog live from the AI/ML API, so new models appear as soon as they are released.
78
+
79
+
The default chat model is `openai/gpt-5.5-2026-04-23`. Any model ID from the [AI/ML API catalog](https://aimlapi.com/models) works, for example `anthropic/claude-sonnet-4-5` or `alibaba/qwen3.8-max-preview` — the configured ID is sent to the API as-is.
80
+
{% endstep %}
81
+
82
+
{% step %}
83
+
### Step 5 — Run Your First Task
84
+
85
+
Ask for something that requires a tool call, for example: "list the files in this folder and summarize them". If the model responds and tools execute, the integration is working.
58
86
59
-
The wizard stores the key as `AIMLAPI_API_KEY` in `~/.atomic-agent/.env` and writes the provider entry to `~/.atomic-agent/config.json`.
87
+
You can return to `/model` at any time to switch the provider or the model. No restart is required.
88
+
{% endstep %}
89
+
{% endstepper %}
60
90
61
-
### Option 2: Manual configuration
91
+
##Manual Configuration
62
92
63
-
Add the provider to the `llm` block of `~/.atomic-agent/config.json`:
93
+
If you prefer editing files over the wizard, add the provider to the `llm` block of `~/.atomic-agent/config.json`:
64
94
65
95
```json
66
96
{
@@ -81,48 +111,26 @@ Add the provider to the `llm` block of `~/.atomic-agent/config.json`:
81
111
82
112
Then put your key in `~/.atomic-agent/.env`:
83
113
84
-
```sh
114
+
```bash
85
115
AIMLAPI_API_KEY=your_key_here
86
116
```
87
117
88
-
The base URL (`https://api.aimlapi.com`) is built into the provider; you do not need to set it.
89
-
90
118
{% hint style="info" %}
91
119
If you prefer the generic `"kind": "openai-compatible"` provider instead, set `"baseUrl": "https://api.aimlapi.com"`**without** the `/v1` suffix. Atomic Agent appends `/v1/chat/completions` itself, and a doubled path returns 404. That provider kind reads its key from `OPENAI_COMPAT_API_KEY`.
92
120
{% endhint %}
93
121
94
-
***
95
-
96
-
## Model Selection
122
+
## Model Notes
97
123
98
-
* Default chat model for the AI/ML API provider: `openai/gpt-5.5-2026-04-23`.
99
-
* Any model ID from the [AI/ML API catalog](https://aimlapi.com/models) works, for example `anthropic/claude-sonnet-4-5` or `alibaba/qwen3.8-max-preview`. The configured model ID is sent to the API as-is, so you are not limited to the bundled list.
100
124
* Embedding models from the AI/ML API catalog can be selected too, or embeddings can stay on the local llama-server daemon.
101
125
* For cloud models, Atomic Agent uses native function calling, so tool use works out of the box.
102
126
103
-
***
104
-
105
-
## Verification
106
-
107
-
Start a session:
108
-
109
-
```sh
110
-
atomic-agent tui
111
-
```
112
-
113
-
Ask for something that requires a tool call, for example: "list the files in this folder and summarize them". If the model responds and tools execute, the integration is working.
114
-
115
-
***
116
-
117
127
## Use Cases
118
128
119
129
***Frontier models inside a local agent.** Keep the agent runtime, tools, and files on your machine while using top cloud models for reasoning.
120
130
***Claude and Gemini in Atomic Agent.** These model families are only reachable through an aggregator; AI/ML API is the supported path.
121
131
***One key, many models.** Switch between model families without separate accounts and billing per provider.
122
132
***Mixed setups.** Run embeddings locally and chat in the cloud, or the other way around.
123
133
124
-
***
125
-
126
134
## Troubleshooting
127
135
128
136
<details>
@@ -157,8 +165,6 @@ Open `/model` in the TUI at any time to change the provider or the chat model. N
0 commit comments