Skip to content

Commit bb76edb

Browse files
SimonSchubertSimonSchubert
committed
Add commands
1 parent eb9bff7 commit bb76edb

2 files changed

Lines changed: 191 additions & 0 deletions

File tree

‎assets/commands/index.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5026,6 +5026,7 @@ nano.md
50265026
nanobot.md
50275027
nanoclaw.md
50285028
nanoeuler.md
5029+
nanomuse.md
50295030
nanosleep.md
50305031
nap.md
50315032
napalm.md

‎assets/commands/nanomuse.md‎

Lines changed: 190 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
1+
# TAGLINE
2+
3+
Open-source personal AI agent with a Sentinel gatekeeper
4+
5+
# TLDR
6+
7+
Write a **starter config** (`config/config.toml`)
8+
9+
```nanomuse config init```
10+
11+
Start an **interactive chat** with the agent
12+
13+
```nanomuse chat```
14+
15+
Resume the **most recent** chat session
16+
17+
```nanomuse chat --resume```
18+
19+
Run **one task** and exit
20+
21+
```nanomuse run "[summarise the files in the workspace]"```
22+
23+
Approve every action **without asking** (unattended)
24+
25+
```nanomuse run --auto "[advance the active goals]"```
26+
27+
Start the **always-on web app** (default `127.0.0.1:8787`)
28+
29+
```nanomuse serve```
30+
31+
Bind so a **phone on the LAN** can reach it
32+
33+
```nanomuse serve --host 0.0.0.0```
34+
35+
Check **config, data dir, model, and connectors**
36+
37+
```nanomuse doctor```
38+
39+
Store a **secret** the model never sees (`{{vault:NAME}}` in config)
40+
41+
```nanomuse vault set [EMAIL_PASSWORD]```
42+
43+
Sign in with a **ChatGPT plan** instead of an API key
44+
45+
```nanomuse chatgpt login```
46+
47+
Print the **version**
48+
49+
```nanomuse --version```
50+
51+
# SYNOPSIS
52+
53+
**nanomuse** [**-V**|**--version**] [_command_] [_options_]
54+
55+
# PARAMETERS
56+
57+
**-V**, **--version**
58+
> Print `nanomuse` and the package version and exit. Same as **nanomuse version**
59+
60+
**-c**, **--config** _path_
61+
> Path to `config.toml`. Without this, the file is searched as `$NANOMUSE_CONFIG`, then `./config/config.toml`, then `~/.nanomuse/config.toml`
62+
63+
**--auto**
64+
> Set the Sentinel to auto mode for this process: approve every action except explicit deny rules. Used by **chat**, **run**, **serve**, **daemon**, and **goals run**. **daemon** always runs in auto mode
65+
66+
**--show-thinking**
67+
> Print the model's reasoning during **chat**, **run**, and **goals run**
68+
69+
**chat**
70+
> Interactive chat. Type a request at the `You ›` prompt. Slash commands: `/help`, `/reset`, `/memory`, `/goals`, `/audit` [_n_], `/tools`, `/tainted`, `/permissions`, `/revoke` _key_, `/forget-approvals`, `/exit`. **--resume** continues the newest session under `<data_dir>/sessions`
71+
72+
**run** _task_
73+
> Run one task and exit
74+
75+
**serve**
76+
> Always-on agent with the mobile-first web app (chat, goals, ideas, memory, approvals). Default bind **127.0.0.1:8787**. **--host** / **--port** (**-p**) override. An access token is printed with a QR code unless **--no-qr**. **--no-auth** turns the token off (local development only)
77+
78+
**daemon**
79+
> Advance every active goal on a loop (Sentinel auto mode). **--interval** is seconds between passes (default 3600). **--once** runs one pass and exits
80+
81+
**doctor**
82+
> Check the install: config, writable data dir, workspace, model, connectors. Paste the output into a bug report. **--no-model** skips the live model call
83+
84+
**audit**
85+
> Show recent Sentinel audit entries. **-n** is how many (default 20). **--json** prints raw JSON lines
86+
87+
**mcp**
88+
> Serve this computer's screen, hands, and configured connectors over MCP on stdio (for the desktop harness). Nothing but the protocol is written to stdout
89+
90+
**config init**
91+
> Copy the bundled example to `config/config.toml` (override with **--path**). **--force** overwrites an existing file
92+
93+
**config show**
94+
> Print the effective configuration as JSON with API keys masked
95+
96+
**config path**
97+
> Print which config file would be used, or say none was found
98+
99+
**vault set** _name_
100+
> Store a secret (prompted, or **--value**). Reference it as `{{vault:NAME}}` in config. **vault list** prints names only. **vault delete** _name_ removes one
101+
102+
**chatgpt login**
103+
> Open a browser and sign in with a ChatGPT plan (PKCE). **status**, **usage**, **logout**, and **proxy** inspect or drop the session or run a loopback OpenAI-compatible server over it. **--json** writes one JSON object per line on stdout
104+
105+
**goals**
106+
> Long-term goals: **list**, **show** _id_, **add** _title_ (**--step**, **--category**, **--due**, **--check-in**), **run** _id_ (let the agent advance it), **status** _id_ `active|paused|done|cancelled`, **delete** _id_
107+
108+
**reminders** / **triggers**
109+
> One-shot reminders and event-driven work (mail, calendar, webhooks): **list**, **add**, **cancel**
110+
111+
**memory**
112+
> Long-term memory: **list**, **add**, **recall**, **forget**, **tidy**, **changes**, **restore** _id_, **clear** (**-y** skips the confirm)
113+
114+
**calendar**
115+
> ICS feeds: **agenda**, **free**, **feeds**, **add** _name_ _url_ (the URL is stored in the vault), **remove** _name_
116+
117+
**contacts**
118+
> Address book: **search**, **list**, **add**, **sources**, **add-source**, **remove-source**
119+
120+
**skills**
121+
> Agent Skills (`SKILL.md` folders): **list**, **show**, **add** (file, folder, or https URL), **new**, **remove**, **enable**, **disable**. User skills live under `<data_dir>/skills`
122+
123+
**channels**
124+
> Chat apps (Feishu, DingTalk, WeCom, Telegram): **status**, **pending**, **approve** _code_, **deny** _code_, **login**, **test**. When **nanomuse serve** is running, these go through its API so the change takes effect at once
125+
126+
**phone traces** / **phone trace** _id_
127+
> GUI-operator traces from phone tasks. **--out** writes a self-contained HTML page of screens and taps
128+
129+
# DESCRIPTION
130+
131+
**nanomuse** is the Python runtime CLI for **nanoMuse**, an open-source personal agent in the style of Meta's Muse. It does work (shell, files, browser, MCP servers, skills, mail, calendar, and optionally the screen of a phone or this computer) instead of only answering questions. A separate **Sentinel** decides what may run and what may leave the machine. Secrets live in a credential vault and are never shown to the model. Every action is written to an audit log.
132+
133+
The console script is `nanomuse` (`nanomuse.cli:app`, Typer). `python -m nanomuse` is the same entry. Python **3.11** or newer is required. The published package version is **0.1.40**. The project is not on PyPI: install from a clone with **uv** (`uv pip install -e ".[dev]"`), then **nanomuse config init**. Optional extras include **browser** (Playwright), **hands** (this computer's screen), and **channels** (Feishu / DingTalk / WeCom SDKs).
134+
135+
**nanomuse serve** starts a FastAPI/Uvicorn app on **127.0.0.1:8787** by default. The phone, desktop, and web clients are separate builds in the same repository (Android APK, iOS TestFlight, Linux AppImage/.deb, Docker relay). Companion binaries **nanomuse-device**, **nanomuse-browser**, and **nanomuse-open** are a CLI bridge the agent uses inside its sandbox; off the phone they exit 2.
136+
137+
On Linux, **[sandbox] mode = "auto"** (the default) runs **shell** and **python_execute** inside **bubblewrap** when it is installed: only the workspace is writable, the home directory is absent, and the network is off unless the command needs it.
138+
139+
# CONFIGURATION
140+
141+
**config.toml search order**
142+
> `--config` / `-c`, then `$NANOMUSE_CONFIG`, then `./config/config.toml`, then `~/.nanomuse/config.toml`. String values may use `${VAR}` or `${VAR:-default}`. Settings changed from the app are layered from `<data_dir>/app-settings.json`
143+
144+
**~/.nanomuse/**
145+
> Default data directory (override with **NANOMUSE_DATA_DIR** or `data_dir` in the config): memory, goals, vault, audit log, sessions, skills, and the generated server token
146+
147+
**~/.nanomuse/config.toml**
148+
> Usual per-user config. **nanomuse config init** writes `config/config.toml` in the current tree instead. Sections include `[llm]`, `[agent]`, `[sentinel]`, `[memory]`, `[connectors.*]`, `[skills]`, `[sandbox]`, `[browser]`, `[gui]`, `[server]`, and `[cloud]`
149+
150+
**[llm]**
151+
> Any OpenAI-compatible endpoint. Defaults are DeepSeek (`deepseek-flash` at `https://api.deepseek.com`, key from **DEEPSEEK_API_KEY**). `provider = "chatgpt"` uses **nanomuse chatgpt login** and needs no key. Catalogue ids such as `bailian` fill in the endpoint
152+
153+
**[sentinel]**
154+
> `ask` (default): sensitive actions need approval. `strict`: moderate and sensitive need approval. `auto`: approve everything except deny rules. `always_ask_tools` defaults to `send_email` and `shell`. Taint tracking blocks egress to non-allowlisted hosts after private data has been read
155+
156+
**{{vault:NAME}}**
157+
> Placeholder in config for a secret stored with **nanomuse vault set**. The model never sees the value
158+
159+
**NANOMUSE_LLM_API_KEY** / **DEEPSEEK_API_KEY** / **OPENAI_API_KEY**
160+
> API keys. **NANOMUSE_LLM_PROVIDER**, **NANOMUSE_LLM_MODEL**, and **NANOMUSE_LLM_BASE_URL** override `[llm]`. **NANOMUSE_WORKSPACE**, **NANOMUSE_SENTINEL_MODE**, **NANOMUSE_SERVER_HOST**, **NANOMUSE_SERVER_PORT**, **NANOMUSE_SERVER_TOKEN**, and **NANOMUSE_CLOUD_BASE_URL** override the matching settings. **NANOMUSE_CONFIG** selects the config file
161+
162+
# CAVEATS
163+
164+
Needs a model: an API key, a ChatGPT sign-in, or a local OpenAI-compatible server. Without one, commands that talk to the model warn and most work fails.
165+
166+
**--auto** and **daemon** approve every Sentinel action except explicit deny rules. **--no-auth** on **serve** is for local development; do not use it on a shared network. The default **serve** bind is loopback only.
167+
168+
The Linux AppImage/.deb is the **desktop GUI**, not this CLI. This command is the Python runtime (`nanomuse` on PATH after an editable install).
169+
170+
The package is not published on PyPI or typical distro indexes. Playwright browsing needs `pip install 'nanomuse[browser]'` and `playwright install chromium`. Screen control needs the **hands** extra. Chat-app channels need their extras and, for Feishu, a QR login.
171+
172+
Sensitive prompts and file contents go to the configured model provider. Conversation text may pass through a nanoMuse relay when cloud sync is on; files and screenshots stay on the device.
173+
174+
# HISTORY
175+
176+
**nanoMuse** is a community project under **GPL-3.0-or-later**. The Python line was MIT in early tags (`pre-openminis`); the phone app is based on **OpenMinis** 1.13 (GPL-3.0). Version **0.1.40** ("Clear") was released in **October 2026**. It is not affiliated with Meta; Muse is their trademark.
177+
178+
# SEE ALSO
179+
180+
[claude](/man/claude)(1), [aider](/man/aider)(1), [opencode](/man/opencode)(1), [codex](/man/codex)(1), [llm](/man/llm)(1), [ollama](/man/ollama)(1), [chatgpt](/man/chatgpt)(1), [python](/man/python)(1), [uv](/man/uv)(1), [bubblewrap](/man/bubblewrap)(1), [playwright](/man/playwright)(1), [uvicorn](/man/uvicorn)(1)
181+
182+
# RESOURCES
183+
184+
```[Source code](https://github.com/nano-muse/nanoMuse)```
185+
186+
```[Homepage](https://nanomuse.cn)```
187+
188+
```[Documentation](https://nanomuse.cn/docs)```
189+
190+
<!-- verified: 2026-10-07 -->

0 commit comments

Comments
 (0)