@knightcodeai/cli-linux-arm64 0.9.1 → 0.9.3

package/bin/docs/quickstart.md

@@ -1,167 +1,122 @@
 # Quickstart
 
-This page gets you from install to a useful first knightcode session.
+KnightCode runs in your terminal and works with files on your machine. To use it, you need access to a model through a supported provider. This can be a subscription, an API key, or a local model.
 
-## Install
+For native Windows setup, read [Windows Setup](windows.md). For Android, read [Termux Setup](termux.md).
 
-KnightCode is distributed as an npm package:
+## 1. Install KnightCode
+
+On macOS or Linux, you can use the installer:
 
 ```bash
-npm install -g --ignore-scripts @knightcodeai/cli
+curl -fsSL https://knightcode.dev/install.sh | sh
 ```
 
-`--ignore-scripts` disables dependency lifecycle scripts during install. KnightCode does not require install scripts for normal npm installs.
-
-### Uninstall
-
-Use the package manager that installed knightcode. The curl installer uses npm globally, so curl and npm installs are removed with npm:
+Alternatively, install KnightCode from npm. This requires Node.js 22 or newer:
 
 ```bash
-# curl installer or npm install -g
-npm uninstall -g @knightcodeai/cli
+npm install -g --ignore-scripts @knightcodeai/cli
+```
 
-# pnpm
-pnpm remove -g @knightcodeai/cli
+KnightCode does not require dependency lifecycle scripts for a normal npm installation.
 
-# Yarn
-yarn global remove @knightcodeai/cli
+Verify the installation:
 
-# Bun
-bun uninstall -g @knightcodeai/cli
+```bash
+knightcode --version
 ```
 
-Uninstalling knightcode leaves settings, credentials, sessions, and installed knightcode packages in `~/.knightcode/agent/`.
+## 2. Start KnightCode
 
-Then start knightcode in the project directory you want it to work on:
+Change to the folder you want KnightCode to work with, then start it:
 
 ```bash
-cd /path/to/project
+cd /path/to/folder
 knightcode
 ```
 
-## Authenticate
+The working folder helps KnightCode discover relevant files, instructions, and configuration. KnightCode also uses it to group saved sessions.
+
+<p align="center"><img src="images/interactive-mode.png" alt="KnightCode running in a terminal with a conversation, input editor, and status footer" width="750"></p>
+
+The interface shows your conversation, an editor for prompts and commands, and a footer with the current folder, model, and session status. See [Use KnightCode in the terminal](usage.md) to learn how to add files, run commands, direct ongoing work, and manage results.
 
-KnightCode can use subscription providers through `/login`, or API-key providers through environment variables or the auth file.
+## 3. Choose a model
 
-### Option 1: subscription login
+A **model** generates KnightCode's responses. A **provider** is the service or account KnightCode uses to access that model.
 
-Start knightcode and run:
+In KnightCode, run:
 
 ```text
 /login
 ```
 
-Then select a provider. Built-in subscription logins include Claude Pro/Max, ChatGPT Plus/Pro (Codex), and GitHub Copilot.
+Choose a provider, then follow the prompts to use a subscription or store an API key. Run `/model` afterward if you want to select a different available model.
 
-### Option 2: API key
+See [Choose a model and provider](models.md) for supported providers, environment-variable authentication, local models, and custom endpoints.
 
-Set an API key before launching knightcode:
+## 4. Give KnightCode a task
 
-```bash
-export ANTHROPIC_API_KEY=sk-ant-...
-knightcode
-```
-
-You can also run `/login` and select an API-key provider to store the key in `~/.knightcode/agent/auth.json`.
-
-See [Providers](providers.md) for all supported providers, environment variables, and cloud-provider setup.
+KnightCode shows each file read, search, command, and edit it performs. It does not ask before every tool call.
 
-## First session
-
-Once knightcode starts, type a request and press Enter:
+Enter a task that matches your work, for example:
 
 ```text
-Summarize this repository and tell me how to run its checks.
+Summarize @meeting-notes.md and save the action items to action-items.md.
 ```
 
-By default, knightcode gives the model four tools:
-
-- `read` - read files
-- `write` - create or overwrite files
-- `edit` - patch files
-- `bash` - run shell commands
-
-Additional built-in read-only tools (`grep`, `find`, `ls`) are available through tool options. KnightCode runs in your current working directory and can modify files there. Use git or another checkpointing workflow if you want easy rollback.
-
-## Give knightcode project instructions
-
-KnightCode loads context files at startup. Add an `AGENTS.md` file to tell it how to work in a project:
-
-```markdown
-# Project Instructions
-
-- Run `npm run check` after code changes.
-- Do not run production migrations locally.
-- Keep responses concise.
+```text
+Explain how this repository is structured and how to run its checks.
 ```
 
-KnightCode loads:
-
-- `~/.knightcode/agent/AGENTS.md` for global instructions
-- `AGENTS.md` or `CLAUDE.md` from parent directories and the current directory
-
-If a directory contains `AGENTS.override.md`, KnightCode loads it instead of `AGENTS.md` or `CLAUDE.md` from that directory.
-
-Restart knightcode, or run `/reload`, after changing context files.
+```text
+Compare @previous.csv with @current.csv and summarize the important changes.
+```
 
-## Common things to try
+Type `@` in the editor to search for a file instead of entering its full path. When KnightCode finishes, review its response and any changed files. Use version control or backups for important work. For untrusted or unattended work, use a container or another sandbox. See [Security](security.md).
 
-### Reference files
+## Continue later
 
-Type `@` in the editor to fuzzy-search files, or pass files on the command line:
+KnightCode saves sessions automatically. Exit KnightCode, then resume the most recent session for the same working folder with:
 
 ```bash
-knightcode @README.md "Summarize this"
-knightcode @src/app.ts @src/app.test.ts "Review these together"
+knightcode --continue
 ```
 
-Images or text can be pasted with Ctrl+V (Alt+V on Windows); images can also be dragged into supported terminals.
+Use `/resume` to choose another saved session. See [Continue or branch a session](sessions.md) for session naming, branching, compaction, export, and sharing.
 
-### Run shell commands
+## Next steps
 
-In interactive mode:
+- [Use KnightCode interactively](usage.md) to learn input, commands, shortcuts, and queued messages.
+- [Add instructions](configuration.md#context-files) that KnightCode should follow whenever it works in a folder.
+- [Choose a model and provider](models.md).
 
-```text
-!npm run lint
-```
-
-The command output is sent to the model. Use `!!command` to run a command without adding its output to the model context.
+### Choose how to customize KnightCode
 
-### Switch models
+Start with the least powerful mechanism that meets your need:
 
-Use `/model` or Ctrl+L to choose a model for the current session. Press Ctrl+S (or Ctrl+D, if your terminal swallows Ctrl+S) in the model picker to save the highlighted model as the startup default. Use `/thinking` to choose a thinking level for the current session, or Ctrl+S / Ctrl+D in that picker to save the startup default thinking level. Use Shift+Tab to cycle thinking level. Use Ctrl+P / Shift+Ctrl+P to cycle through scoped models.
+| Need | Start with |
+|---|---|
+| Give KnightCode persistent instructions for a folder | [`AGENTS.md`](configuration.md#context-files) |
+| Reuse a prompt from the `/` menu | [Prompt template](prompt-templates.md) |
+| Add task-specific instructions and supporting files | [Skill](skills.md) |
+| Add executable tools, commands, or event handlers | [Extension](extensions.md) |
+| Build a custom terminal component | [Terminal UI](tui.md) |
+| Connect an unsupported model service | [Custom provider](custom-provider.md) |
+| Install or distribute several resources | [KnightCode package](packages.md) |
 
-### Continue later
+## Uninstall KnightCode
 
-Sessions are saved automatically:
+If you installed KnightCode with npm, run:
 
 ```bash
-knightcode -c                  # Continue most recent session
-knightcode -r                  # Browse previous sessions
-knightcode --name "my task"    # Set session display name at startup
-knightcode --session <path|id> # Open a specific session
+npm uninstall -g @knightcodeai/cli
 ```
 
-Inside knightcode, use `/resume`, `/new`, `/undo`, `/tree`, `/fork`, and `/clone` to manage sessions.
-
-### Non-interactive mode
-
-For one-shot prompts:
+If you used the installer, run it again and choose **Uninstall KnightCode**:
 
 ```bash
-knightcode -p "Summarize this codebase"
-cat README.md | knightcode -p "Summarize this text"
-knightcode -p @screenshot.png "What's in this image?"
+curl -fsSL https://knightcode.dev/install.sh | sh
 ```
 
-Use `--mode json` for JSON event output or `--mode rpc` for process integration.
-
-## Next steps
-
-- [Using KnightCode](usage.md) - interactive mode, slash commands, sessions, context files, and CLI reference.
-- [Providers](providers.md) - authentication and model setup.
-- [Settings](settings.md) - global and project configuration.
-- [Keybindings](keybindings.md) - shortcuts and customization.
-- [KnightCode Packages](packages.md) - install shared extensions, skills, prompts, and themes.
-
-Platform notes: [Windows](windows.md), [Termux](termux.md), [tmux](tmux.md), [Terminal setup](terminal-setup.md), [Shell aliases](shell-aliases.md).
+Neither method removes configuration, credentials, sessions, or installed KnightCode packages from `~/.knightcode/agent/`.