@knightcodeai/cli-linux-x64 0.9.1 → 0.9.3

package/bin/docs/sessions.md

@@ -1,123 +1,40 @@
-# Sessions
+# Sessions and Context
 
-KnightCode saves conversations as sessions so you can continue work, branch from earlier turns, and revisit previous paths.
+KnightCode saves a conversation as a session. The active branch of that session supplies conversation history for the next model request. Use session commands to continue work, explore another branch, or reduce the amount of history sent to the model.
 
-## Session Storage
+## Continue or switch sessions
 
-Sessions auto-save to `~/.knightcode/agent/sessions/`, organized by working directory. Each session is a JSONL file with a tree structure.
+KnightCode saves sessions automatically unless you start it with `--no-session`.
 
 ```bash
-knightcode -c                  # Continue most recent session
-knightcode -r                  # Browse and select from past sessions
-knightcode --no-session        # Ephemeral mode; do not save
-knightcode --name "my task"    # Set session display name at startup
-knightcode --session <path|id> # Use a specific session file or partial session ID
-knightcode --fork <path|id>    # Fork a session file or partial session ID into a new session
+knightcode --continue
+knightcode --resume
 ```
 
-Use `/session` in interactive mode to see the current session file, session ID, message count, tokens, and cost.
+`--continue` opens the most recent session for the current working directory. `--resume` opens the session picker. In interactive mode, `/resume` opens the same picker and `/new` starts a new session.
 
-For the JSONL file format and SessionManager API, see [Session Format](session-format.md).
+Use `/name` or `--name` to assign a recognizable session name. Run `/session` to verify the current session file, ID, message count, token usage, and cost.
 
-## Session Commands
+The session picker lets you search, rename, and delete sessions. It can also show paths, change sorting, and limit results to named sessions. See [Keybindings](keybindings.md#sessions) for its shortcuts.
 
-| Command | Description |
-|---------|-------------|
-| `/resume` | Browse and select previous sessions |
-| `/new` | Start a new session |
-| `/name <name>` | Set the current session display name |
-| `/session` | Show session info |
-| `/tree` | Navigate the current session tree |
-| `/undo` | Go back to an earlier user message, optionally restoring files |
-| `/fork` | Create a new session from a previous user message |
-| `/clone` | Duplicate the current active branch into a new session |
-| `/compact [prompt]` | Summarize older context; see [Compaction](compaction.md) |
-| `/export [file]` | Export session to HTML |
-| `/share` | Upload as private GitHub gist with shareable HTML link |
-| `/bug [description]` | Report a bug to the KnightCode developers; see [Reporting Bugs](#reporting-bugs) |
+## Choose how to branch
 
-## Resuming and Deleting Sessions
+KnightCode stores entries as a tree, so returning to an earlier point does not erase the branch you leave.
 
-`/resume` opens an interactive session picker for the current project. `knightcode -r` opens the same picker at startup.
+| Action | Result | Use it when |
+|---|---|---|
+| `/tree` | Moves within the current session file | Related alternatives should stay together |
+| `/fork` | Creates a new session from an earlier user message | The alternative should become separate work |
+| `/clone` | Copies the active branch into a new session | You want a separate copy of the current state |
+| `/undo` | Returns to an earlier user message on the current branch, optionally restoring files | You want to take back the last turns |
 
-In the picker you can:
-
-- search by typing
-- toggle path display with Ctrl+P
-- toggle sort mode with Ctrl+S
-- filter to named sessions with Ctrl+N
-- rename with Ctrl+R
-- delete with Ctrl+D, then confirm
-
-When available, knightcode uses the `trash` CLI for deletion instead of permanently removing files.
-
-## Naming Sessions
-
-Use `/name <name>` to set a human-readable session name:
-
-```text
-/name Refactor auth module
-```
-
-Set the name at startup with `--name` or `-n`:
-
-```bash
-knightcode --name "Refactor auth module"
-knightcode --name "CI audit" -p "Review this build failure"
-```
-
-Named sessions are easier to find in `/resume` and `knightcode -r`.
-
-## Branching with `/tree`
-
-Sessions are stored as trees. Every entry has an `id` and `parentId`, and the current position is the active leaf. `/tree` lets you jump to any previous point and continue from there without creating a new file.
+In `/tree`, select a user message to put its text back in the editor. Edit and submit it to create another branch. Selecting an assistant response or another entry continues after that entry with an empty editor.
 
 Selecting a point while the model is responding cancels that response. Navigation cannot proceed while compaction or another tree navigation is still running; wait for it to finish and retry.
 
-<p align="center"><img src="images/tree-view.png" alt="Tree View" width="600"></p>
-
-Example shape:
+When you leave a branch, KnightCode can summarize it and attach that summary to the branch you enter. This preserves relevant work from the abandoned path without including every message from it.
 
-```text
-├─ user: "Hello, can you help..."
-│  └─ assistant: "Of course! I can..."
-│     ├─ user: "Let's try approach A..."
-│     │  └─ assistant: "For approach A..."
-│     │     └─ user: "That worked..."  ← active
-│     └─ user: "Actually, approach B..."
-│        └─ assistant: "For approach B..."
-```
-
-### Tree Controls
-
-| Key | Action |
-|-----|--------|
-| ↑/↓ | Navigate visible entries |
-| ←/→ | Page up/down |
-| Ctrl+←/Ctrl+→ or Alt+←/Alt+→ | Fold/unfold or jump between branch segments |
-| Shift+L | Set or clear a label on the selected entry |
-| Shift+T | Toggle label timestamps |
-| Enter | Select entry |
-| Escape/Ctrl+C | Cancel |
-| Ctrl+O | Cycle filter mode |
-
-Filter modes are: default, no-tools, user-only, labeled-only, and all. Configure the default with `treeFilterMode` in [Settings](settings.md).
-
-### Selection Behavior
-
-Selecting a user or custom message:
-
-1. Moves the leaf to the selected message's parent.
-2. Places the selected message text in the editor.
-3. Lets you edit and resubmit, creating a new branch.
-
-Selecting an assistant, tool, compaction, or other non-user entry:
-
-1. Moves the leaf to that entry.
-2. Leaves the editor empty.
-3. Lets you continue from that point.
-
-Selecting the root user message resets the leaf to an empty conversation and places the original prompt in the editor.
+For the persisted tree and entry types, see [Session Format](session-format.md).
 
 ## Undoing with `/undo`
 
@@ -125,7 +42,8 @@ Selecting the root user message resets the leaf to an empty conversation and pla
 branch and go back to it. It lists only user messages, newest at the bottom, with the time
 and how many files an undo to that point would restore. Enter goes back; the turns after the
 chosen message are left as an abandoned branch (still reachable through `/tree`) and the
-message text returns to the editor for editing and resubmitting.
+message text returns to the editor for editing and resubmitting. `/undo` never summarizes the
+branch it leaves.
 
 ### File Restore
 
@@ -153,57 +71,34 @@ Limits:
 Backups older than 30 days are removed at startup. Set `KNIGHTCODE_DISABLE_FILE_CHECKPOINTS=1`
 to turn file tracking off; `/undo` then rewinds the conversation only.
 
-## `/tree`, `/fork`, and `/clone`
-
-| Feature | `/tree` | `/fork` | `/clone` |
-|---------|---------|---------|----------|
-| Output | Same session file | New session file | New session file |
-| View | Full tree | User-message selector | Current active branch |
-| Typical use | Explore alternatives in place | Start a new session from an earlier prompt | Duplicate current work before continuing |
-| Summary | Optional branch summary | None | None |
-
-Use `/tree` when you want to keep alternatives together. Use `/fork` or `/clone` when you want a separate session file.
-
-## Branch Summaries
-
-When `/tree` switches away from one branch to another, knightcode can summarize the abandoned branch and attach that summary at the new position. This preserves important context from the path you left without replaying the whole branch.
-
-When prompted, choose one of:
+## Manage conversation context
 
-1. no summary
-2. summarize with the default prompt
-3. summarize with custom focus instructions
+The model receives the active branch, not every branch in the session file. KnightCode combines that history with the system prompt, discovered context files, available tools, and loaded skill descriptions. [How KnightCode Works](how-knightcode-works.md#context) describes how those inputs are assembled.
 
-See [Compaction](compaction.md) for branch summarization internals and extension hooks.
+The footer shows current context usage. When the active context approaches the model's limit, KnightCode normally compacts older history automatically. Compaction adds a summary and keeps recent messages. It does not delete the original session entries.
 
-## Reporting Bugs
+Run `/compact` to compact manually. You can add instructions when the summary should preserve a particular topic or decision. Configure automatic compaction and retained history through [Settings](settings.md#compaction).
 
-`/bug [description]` collects a bug report for the KnightCode maintainers. The report is not shared publicly. The dialog asks for an optional description and whether to include the session transcript. If you decline the transcript, KnightCode offers to have the current model write a summary of what went wrong instead; the transcript is sent to your provider with your credentials, and only the summary is attached.
+Compaction can fail if the provider is unavailable or cannot accept the summarization request. Correct the provider problem and run `/compact` again. Disabling automatic compaction does not disable the manual command.
 
-The last step chooses where the report goes:
+See [Compaction Reference](compaction.md) for thresholds, retained boundaries, branch-summary behavior, and extension hooks.
 
-- **Upload Report** sends it to the KnightCode maintainers through `remote.knightcode.dev`. No login is required and reports are always anonymous. If the upload fails, KnightCode offers to export the zip instead.
-- **Export as Zip** writes a zip archive to the current directory. Attach it to an issue or send it to the developers yourself.
+## Control session storage
 
-Both contain the same files:
+By default, KnightCode stores sessions under `~/.knightcode/agent/sessions/`, grouped by working directory. Use `--session-dir`, `KNIGHTCODE_CODING_AGENT_SESSION_DIR`, or the `sessionDir` setting to choose another location. The CLI option has highest precedence.
 
-| File | Content |
-|------|---------|
-| `report.json` | KnightCode version, runtime, OS, terminal, current model and provider configuration, loaded extensions, and settings. API keys, header values, URL credentials, and the analytics tracking id are never included. |
-| `diagnostics.json` | Provider and runtime error diagnostics attached to assistant messages across the whole session (failed or aborted turns, retries, error messages), plus any recorded crashes. Always included; message content is not. |
-| `session.jsonl` | The current branch of the session, only when you chose to include it. It contains file contents and command output read during the session. |
-| `summary.md` | The model-written summary, only when you chose to generate one. |
+Use `--no-session` for an ephemeral run. An ephemeral session cannot be resumed after KnightCode exits.
 
-Each report has a UUID. KnightCode shows it after upload or export and records it in the session as a `knightcode.bug-report` entry so you can refer to it later.
+Use `--session` when you already know the session path or ID. Use `--fork` to create a new session from an existing session before interactive mode starts.
 
-Set `KNIGHTCODE_RADIUS_GATEWAY` to upload to a different Radius deployment.
+## Export or share a session
 
-### Crashes
+Use `/export` to write the current session as HTML or JSONL. Use `/share` to upload it and get a viewer link. KnightCode uses a Radius artifact when Radius authentication is configured; otherwise, it uses a private GitHub gist.
 
-When KnightCode exits because of an uncaught exception or a fatal runtime error, it stores the error message and stack trace in `~/.knightcode/agent/crashes.json` (the newest five). The next interactive start shows a warning once; running `/bug` attaches the stored crashes to `diagnostics.json` and removes the file after the report is uploaded or exported. Resume the crashed session with `knightcode -r` first if you want the transcript in the report.
+Review exported or shared sessions first. They can contain prompts, model responses, tool arguments, command output, file contents, and extension messages.
 
-## Session Format
+## Report a bug
 
-Session files are JSONL and contain message entries, model changes, thinking-level changes, labels, compactions, branch summaries, and extension entries.
+Run `/bug [description]` to prepare a private report for the KnightCode maintainers. You can include the session transcript, omit it, or ask the current model to summarize the problem. Review any transcript or generated summary because it can contain sensitive conversation data.
 
-For parsers, extensions, SDK usage, and the full SessionManager API, see [Session Format](session-format.md).
+The report includes environment and provider configuration without credential values, plus recorded error diagnostics. Upload it to the maintainers through `remote.knightcode.dev` or export the same report as a zip to inspect and share yourself. Uploads do not require a login and are always anonymous. If an upload fails, KnightCode offers to export the zip.