Skip to content

Commit da793c9

Browse files
Merge pull request #458 from sosidudku1/docs/atomic-agent-stepper
Restyle Atomic Agent guide with stepper components
2 parents f158f6f + 85b872b commit da793c9

2 files changed

Lines changed: 52 additions & 46 deletions

File tree

-19.3 KB
Binary file not shown.

docs/integrations/atomic-agent.md

Lines changed: 52 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# ⚛️ Atomic Agent
22

3-
<div align="left" data-with-frame="false"><figure><img src="../.gitbook/assets/atomic-agent-logo.png" alt="Atomic Agent logo" width="188"><figcaption></figcaption></figure></div>
4-
53
## About
64

75
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.
2422
* Telegram connector and an OpenAI-compatible local HTTP server
2523
* MIT license, installs without an account
2624

25+
## Prerequisites
26+
27+
* An AIMLAPI key obtained from your [account dashboard](https://aimlapi.com/app/keys)
28+
2729
***
2830

29-
## Quick Install
31+
{% stepper %}
32+
{% step %}
33+
### Step 1 — Install Atomic Agent
3034

31-
One command, no account or key required:
35+
One command, no account or key required.
3236

33-
```sh
34-
# macOS / Linux
37+
macOS / Linux:
38+
39+
```bash
3540
curl -fsSL https://atomicagent.io/install | sh
3641
```
3742

43+
Windows:
44+
3845
```powershell
39-
# Windows
4046
irm https://atomicagent.io/install.ps1 | iex
4147
```
48+
{% endstep %}
4249

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 %}
4465

45-
## Configuration
66+
{% step %}
67+
### Step 3 — Connect AI/ML API
4668

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.
4870

49-
### Option 1: Built-in provider wizard (recommended)
71+
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 %}
5073

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
5276

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.
5886

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 %}
6090

61-
### Option 2: Manual configuration
91+
## Manual Configuration
6292

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`:
6494

6595
```json
6696
{
@@ -81,48 +111,26 @@ Add the provider to the `llm` block of `~/.atomic-agent/config.json`:
81111

82112
Then put your key in `~/.atomic-agent/.env`:
83113

84-
```sh
114+
```bash
85115
AIMLAPI_API_KEY=your_key_here
86116
```
87117

88-
The base URL (`https://api.aimlapi.com`) is built into the provider; you do not need to set it.
89-
90118
{% hint style="info" %}
91119
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`.
92120
{% endhint %}
93121

94-
***
95-
96-
## Model Selection
122+
## Model Notes
97123

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.
100124
* Embedding models from the AI/ML API catalog can be selected too, or embeddings can stay on the local llama-server daemon.
101125
* For cloud models, Atomic Agent uses native function calling, so tool use works out of the box.
102126

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-
117127
## Use Cases
118128

119129
* **Frontier models inside a local agent.** Keep the agent runtime, tools, and files on your machine while using top cloud models for reasoning.
120130
* **Claude and Gemini in Atomic Agent.** These model families are only reachable through an aggregator; AI/ML API is the supported path.
121131
* **One key, many models.** Switch between model families without separate accounts and billing per provider.
122132
* **Mixed setups.** Run embeddings locally and chat in the cloud, or the other way around.
123133

124-
***
125-
126134
## Troubleshooting
127135

128136
<details>
@@ -157,8 +165,6 @@ Open `/model` in the TUI at any time to change the provider or the chat model. N
157165

158166
</details>
159167

160-
***
161-
162168
## Links
163169

164170
* Website: [atomicagent.io](https://atomicagent.io)

0 commit comments

Comments
 (0)