| name | nocturnal |
| description | Nocturnal product docs. Use for install, config, providers/API keys, sandbox, slash commands, subagents, plugins, Telegram/Discord, upgrade, troubleshooting, or any product-feature question. |
Nocturnal Documentation
Shipped user-facing docs for Nocturnal (generated from docs/features/ at
package time). Do not invent product behavior — read the relevant page.
Also covers: sessions, memory, aliases, desktop, TUI, voice, images,
cron, heartbeat, checklist, compaction, and the rest of the topic table.
How to use
- Pick the topic that matches the question from the table below.
- Load it with the read tool using an absolute path from this skill root:
<skill_root>/references/<file>
<skill_root> is the directory that contains this SKILL.md. Example:
for providers, read <skill_root>/references/providers.md (resolve the
absolute path first — never a CWD-relative references/... path).
- Answer from the loaded page. If several topics apply, load each that is
needed — do not load the entire set up front.
Topics
| Topic | Title | File |
|---|
agent-definitions | Agent Definitions | references/agent-definitions.md |
agent-skills | Agent Skills | references/agent-skills.md |
architecture | Architecture | references/architecture.md |
checklist-mode | Checklist Mode | references/checklist-mode.md |
cli-mode | CLI/Scripting Mode | references/cli-mode.md |
client-server | Client/Server Architecture | references/client-server.md |
code-navigation | Code Navigation and Refactoring | references/code-navigation.md |
computer-use | Computer Use | references/computer-use.md |
configuration-reference | Configuration Reference | references/configuration-reference.md |
context-compaction | Context Compaction | references/context-compaction.md |
cron | Cron — Scheduled and Recurring Tasks | references/cron.md |
cross-session-memory | Cross-Session Memory | references/cross-session-memory.md |
desktop | Desktop App | references/desktop.md |
desktop-companion | Ambient Desktop Companion | references/desktop-companion.md |
discord | Discord Integration | references/discord.md |
dot-env | Dot-Env File (~/.nocturnal/secrets/.env) | references/dot-env.md |
external-editor | External Editor | references/external-editor.md |
getting-started | Getting Started | references/getting-started.md |
heartbeat | Heartbeat — Periodic Agent Check-Ins | references/heartbeat.md |
images | Images | references/images.md |
loop-protection | Loop Protection | references/loop-protection.md |
multi-provider-aliases | Multi-Provider Aliases | references/multi-provider-aliases.md |
pause-resume | Pause and Resume | references/pause-resume.md |
performance | Performance | references/performance.md |
persistent-repl | Persistent Python REPL (RLM) | references/persistent-repl.md |
plugins | Plugins | references/plugins.md |
providers | Providers | references/providers.md |
sandboxing | Sandboxing | references/sandboxing.md |
session-storage | Session Storage | references/session-storage.md |
sessions | Sessions | references/sessions.md |
slash-commands | Slash Commands | references/slash-commands.md |
smart-edit | Smart Edit | references/smart-edit.md |
streaming | Streaming | references/streaming.md |
subagents | Subagents | references/subagents.md |
telegram | Telegram Integration | references/telegram.md |
tui | TUI | references/tui.md |
upgrade | Upgrade and Revert | references/upgrade.md |
voice-dictation | Voice Dictation | references/voice-dictation.md |
First-run and common hurdles
| Situation | Start here |
|---|
| Fresh install, first session | references/getting-started.md |
| API keys / providers | references/providers.md, references/dot-env.md |
| Config file layout | references/configuration-reference.md |
| Agent cannot write files | references/sandboxing.md |
| Slash commands | references/slash-commands.md |
| Subagents / multi-agent | references/subagents.md |
| Telegram / Discord | references/telegram.md, references/discord.md |
| Upgrade broke something | references/upgrade.md |
Note for humans
These files also live on disk after install at:
~/.nocturnal/skills/nocturnal/references/
Browse or open them in an editor directly if you prefer not to go through
the agent.
