/docs
Guide
Commands

Know where to type each Spark command.

Some commands go in Terminal, CMD, or PowerShell. Some go inside your Telegram bot. Some things are better clicked in Mission Control. Provider commands use the same Agent and Mission roles from setup.

Tell Spark what you are trying to do.

Start here if the command list feels like too much. Pick the situation that matches your moment; Spark shows where to type it, what it does, and what a good result looks like.

Command tutorial Pick a moment. Watch the exact move.
Computer terminal

Turn Spark on without extra terminal windows.

spark live start
Use it for
Starts the background Spark services: Telegram bot, Mission Control, and the local relay pieces Spark needs.
You should see
Spark says services are ready and shows the current Mission Control URL when it is available.
Try next
spark live status or send /diagnose in Telegram.

The three places Spark commands live.

If you know the surface, the command becomes much less scary.

01

Computer terminal

Use CMD, PowerShell, macOS Terminal, Linux shell, WSL, Codex, Claude Code, or another local coding assistant.

spark status
02

Telegram bot

Use slash commands inside the Spark bot you created with BotFather.

/diagnose
03

Mission Control

Use the browser UI when you want to see builds, Kanban, Canvas, and mission progress. The port can change, so use the URL Spark prints.

spark live status

First-day path.

Use this order when Spark is freshly installed or when you are helping someone else get unstuck.

Terminal

Set up Spark once

spark setup spark guide Expected: setup finishes, then the guide explains Telegram, LLMs, what Spark can do, and first checks.
Terminal

Choose and test the model path

spark recommend llms spark providers status spark providers test --role chat Expected: chat, agent memory, and mission roles show the provider you chose.
Terminal

Turn Spark on quietly

spark live start spark live status spark autostart install --now Expected: Spark Live runs in the background without extra black terminal windows.
Telegram

Confirm the bot is alive

/diagnose

Telegram, LLM, memory, and Mission Control are checked.

/remember I like concise warm replies

Saved through Spark memory.

Telegram + Mission Control

Start a tiny build

/run say exactly OK

Spark creates a mission, posts progress in Telegram, and shows the work in Kanban or Canvas.

Find a command by need.

Search like a person. Try words like quiet, model, memory, build, logs, security, or update.

Terminalspark setup

Run first-time setup for Telegram, provider, and access defaults.

Terminalspark live start

Start Spark services quietly in the background.

Terminalspark live run

Run Spark with one combined visible console.

Terminalspark live status

Check whether Spark Live is running.

Terminalspark live logs

Read recent Spark Live logs.

Terminalspark recommend llms

See recommended LLM paths for Spark.

Terminalspark providers status

After setup, check chat, memory, and mission model wiring.

Terminalspark fix telegram

Repair the most common Telegram bot issues.

Terminalspark fix spawner

Repair Mission Control or Spawner reachability issues.

Terminalspark logs spark-telegram-bot --lines 80

Read recent Telegram bot logs.

Terminalspark support bundle

Create a local redacted support archive.

Terminalspark security audit

Check Spark security posture and common risky settings.

Terminalspark approval classify "delete local logs"

Check whether an action needs approval.

Terminalspark secrets list

Confirm stored secret IDs without printing values.

Terminalspark list

Show installed Spark modules.

Terminalspark search memory

Search the local Spark module registry.

Terminalspark config list

Inspect local Spark config while debugging.

Terminalspark doctor --json

Show structured diagnostics for agents or support.

Terminalspark restart spawner-ui

Restart one Spark module when a repair guide asks.

Terminalspark start telegram-starter

Start a specific module bundle when support asks.

Terminalspark stop telegram-starter

Stop a specific module bundle when support asks.

Terminalspark install <module-name>

Install another Spark module after reviewing it.

Terminalspark init my-module

Scaffold a new Spark module.

Terminalspark uninstall <module-name>

Remove a Spark module intentionally.

Terminalspark update --skip-dirty

Update clean modules while preserving repos with local edits.

Telegram/diagnose

Check Spark health from inside Telegram.

Telegram/remember <note>

Save something Spark should remember.

Telegram/recall <topic>

Search Spark memory.

Telegram/run <goal>

Start a build, research, or coding mission.

Telegram/board

Show running and completed missions.

Telegram/access 3

Let Spark research and build when explicitly asked.

Command playbook.

Use this when you know the problem but not the command. Each card shows where to type it, why it exists, and what a good result should feel like.

Computer terminal

I just installed Spark and need the first setup.

spark setup
Use it for
Walks through Telegram, LLM provider, what Spark can do, and module wiring.
You should see
Setup ends with next steps, provider roles, and a safe place to test the bot.
Computer terminal

I forgot what to do next.

spark guide
Use it for
Shows the friendly starter path: BotFather, providers, start commands, Telegram commands, and fixes.
You should see
You get a readable checklist instead of guessing from old terminal output.
Computer terminal

I want Spark running without extra terminal windows.

spark live start
Use it for
Starts the background services Spark needs, including Telegram, Mission Control, and relay pieces.
You should see
The terminal says Spark Live is ready, shows service health, and gives you the Mission Control URL when Spawner is running.
Computer terminal

I want one live console showing what Spark is doing.

spark live run
Use it for
Starts Spark Live and keeps one combined log console open for debugging.
You should see
One terminal shows the important Spark services instead of several separate windows.
Computer terminal

I want to know whether Spark is actually on.

spark live status
Use it for
Checks whether Spark Live is supervising the running services.
You should see
You can see which services are running and which one needs attention.
Computer terminal

I want to read Spark Live logs.

spark live logs
Use it for
Shows recent combined Spark Live logs when the background agent is acting strange.
You should see
Service messages that help explain whether Telegram, Mission Control, or provider wiring is stuck.
Computer terminal

I want Spark to start every time this computer logs in.

spark autostart install --now
Use it for
Installs login startup and starts Spark immediately.
You should see
After reboot, Spark can come back without you manually opening terminals.
Computer terminal

I need help choosing a model provider.

spark recommend llms
Use it for
Explains recommended provider paths for subscriptions, API keys, and local models.
You should see
You know which provider to connect before running setup again.
Computer terminal

I need to see what model Spark is using.

spark providers status
Use it for
After setup, shows the configured chat, memory, agent, and mission provider wiring.
You should see
You can spot if chat is on one model while missions are on another.
Computer terminal

I want to test a provider before trusting it.

spark providers test --role chat
Use it for
Sends a small test through the selected provider role.
You should see
Spark confirms the provider responds, or shows the exact provider issue to fix.
Computer terminal

Something feels broken and I need a broad health check.

spark status
Use it for
Checks modules, provider wiring, and common repair hints.
You should see
You get OK or repair lines that point to the next command.
Computer terminal

I want proof the onboarding path works.

spark verify --onboarding
Use it for
Runs the launch checks for modules, long polling, memory bridge, LLM roles, and runtime processes.
You should see
Everything important says OK, or Spark tells you the first repair step.
Computer terminal

The Telegram bot is quiet.

spark fix telegram
Use it for
Checks token, admin IDs, polling, provider wiring, runtime bridge, and recent bot trouble spots.
You should see
You get a focused repair path instead of a generic "try again later."
Computer terminal

Mission Control or builds are not reachable.

spark fix spawner
Use it for
Checks the local Spawner/Mission Control service, the current browser port, and the relay Spark uses for builds.
You should see
Spark tells you whether to start the service, use a different localhost URL, repair provider config, or inspect logs.
Computer terminal

I need to connect or replace my Telegram bot token.

spark telegram connect
Use it for
Guides BotFather token entry without making you hunt for secret files.
You should see
The token is saved locally, routed only to the Telegram bot, and ready for restart.
Computer terminal

I want to confirm secrets exist without printing them.

spark secrets list
Use it for
Lists saved secret IDs and storage backend without showing token or API key values.
You should see
Secret names such as Telegram or provider keys, with values still protected.
Computer terminal

I want to see what Spark modules are installed.

spark list
Use it for
Shows the locally installed Spark modules and their manifest state.
You should see
The core starter modules, such as Spark Telegram Bot, Spark Intelligence Builder, memory, Researcher, character, and Mission Control.
Computer terminal

I need to update Spark without overwriting local edits.

spark update --skip-dirty
Use it for
Updates clean modules while leaving repos with local changes alone.
You should see
You get newer safe modules without losing your own work.
Computer terminal

I need recent logs because something still feels wrong.

spark logs spark-telegram-bot --lines 80
Use it for
Shows recent Telegram bot logs without exposing secrets by default.
You should see
You can see the error family: provider, token, admin ID, service, or runtime crash.
Computer terminal

I want Spark to explain a hard problem with my own LLM.

spark doctor llm "Telegram bot is quiet"
Use it for
Builds a redacted diagnostic prompt and asks your configured LLM for a fix plan.
You should see
You get a local report with next commands, not an automatic risky edit.
Computer terminal

I want a local support package I can review before sharing.

spark support bundle
Use it for
Creates a local, redacted troubleshooting bundle for support or upstream issue reports.
You should see
A local archive path and a reminder to review it before sending anything.
Computer terminal

I want to check Spark's local security posture.

spark security audit
Use it for
Checks secrets, provider wiring, Telegram ingress mode, and risky local settings.
You should see
Clear OK, warning, or repair lines without exposing private tokens.
Computer terminal

I want to know whether an action should ask approval first.

spark approval classify "delete local logs"
Use it for
Checks how Spark classifies sensitive actions before an agent or user performs them.
You should see
A clear approval category so risky actions can be slowed down instead of guessed.
Computer terminal

I want to find another Spark module.

spark search memory
Use it for
Searches the local blessed registry by module name or summary.
You should see
Matching Spark modules before you decide whether to install anything.
Computer terminal

I need to inspect advanced config while debugging.

spark config list
Use it for
Shows the local Spark user config as JSON for agents or support helpers.
You should see
Configuration values that explain routing and profiles; secrets should remain in the secret store.
Computer terminal

I need structured diagnostics for an agent or support helper.

spark doctor --json
Use it for
Prints diagnostic state in a structured format that another tool can read.
You should see
JSON-style health information instead of only human text.
Computer terminal

I need to restart one Spark piece, not everything.

spark restart spawner-ui
Use it for
Restarts one module when a repair guide names the exact service.
You should see
That module stops, starts again, and reports whether it became healthy.
Computer terminal

A support guide tells me to start a specific bundle.

spark start telegram-starter
Use it for
Starts a named Spark bundle or module directly. For normal daily use, prefer Spark Live.
You should see
Spark reports which services started and whether any dependency is unhealthy.
Computer terminal

A support guide tells me to stop a specific bundle.

spark stop telegram-starter
Use it for
Stops a named Spark bundle or module directly when you are repairing a specific service.
You should see
Spark reports what stopped and what was already inactive.
Computer terminal

I found a module and want to install it.

spark install <module-name>
Use it for
Installs a Spark module from the registry or a local repo after you review what it is.
You should see
An install plan, trust checks, and a clear success or repair message.
Computer terminal

I want to create a new Spark module.

spark init my-module
Use it for
Scaffolds a new Spark module with the starter manifest files.
You should see
A new local module folder ready for editing and testing.
Computer terminal

I need to remove a module on purpose.

spark uninstall <module-name>
Use it for
Removes a Spark module intentionally. Use destructive cleanup flags only when you mean it.
You should see
Spark explains what was removed and what local state remains.
Telegram bot

I want to check Spark from inside Telegram.

/diagnose
Use it for
Checks the bot, LLM route, Mission Control, and current admin wiring from chat.
You should see
The bot tells you what is OK and what needs a terminal repair command.
Telegram bot

I want Spark to remember something useful.

/remember I like concise warm replies
Use it for
Saves a memory through Spark memory when the bridge is healthy.
You should see
Spark confirms the memory and can recall it later.
Telegram bot

I want to check what Spark remembers.

/recall concise warm replies
Use it for
Searches Spark memory for the topic you ask about.
You should see
Spark returns the saved memory or tells you there is nothing useful yet.
Telegram bot

I want Spark to build or research something.

/run Build a tiny notes app
Use it for
Creates a mission and sends it to the configured mission provider.
You should see
Telegram confirms the mission, then Kanban or Canvas shows progress.
Telegram bot

I want to see what is running.

/board
Use it for
Shows running, completed, and failed missions from Telegram.
You should see
You can see whether Spark is still working or has finished.
Telegram bot

I want Spark to research and build when I ask.

/access 3
Use it for
Lets Spark research and create missions when you explicitly ask.
You should see
Spark can use research and mission tools when you explicitly ask it to build.
Browser

I want to watch mission progress visually.

Mission Control URL + /kanban
Use it for
Opens the local Kanban board for current and recent missions after Spark Live or Spawner is running.
You should see
spark live status prints the current URL. Add /kanban to that URL. If the browser says connection refused, run spark fix spawner.