@knightcodeai/cli-win32-x64 0.4.1 → 0.5.0

package/bin/docs/quickstart.md

@@ -0,0 +1,167 @@
+# Quickstart
+
+This page gets you from install to a useful first knightcode session.
+
+## Install
+
+KnightCode is distributed as an npm package:
+
+```bash
+npm install -g --ignore-scripts @knightcodeai/cli
+```
+
+`--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:
+
+```bash
+# curl installer or npm install -g
+npm uninstall -g @knightcodeai/cli
+
+# pnpm
+pnpm remove -g @knightcodeai/cli
+
+# Yarn
+yarn global remove @knightcodeai/cli
+
+# Bun
+bun uninstall -g @knightcodeai/cli
+```
+
+Uninstalling knightcode leaves settings, credentials, sessions, and installed knightcode packages in `~/.knightcode/agent/`.
+
+Then start knightcode in the project directory you want it to work on:
+
+```bash
+cd /path/to/project
+knightcode
+```
+
+## Authenticate
+
+KnightCode can use subscription providers through `/login`, or API-key providers through environment variables or the auth file.
+
+### Option 1: subscription login
+
+Start knightcode and run:
+
+```text
+/login
+```
+
+Then select a provider. Built-in subscription logins include Claude Pro/Max, ChatGPT Plus/Pro (Codex), and GitHub Copilot.
+
+### Option 2: API key
+
+Set an API key before launching knightcode:
+
+```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.
+
+## First session
+
+Once knightcode starts, type a request and press Enter:
+
+```text
+Summarize this repository and tell me how to run its checks.
+```
+
+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.
+```
+
+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.
+
+## Common things to try
+
+### Reference files
+
+Type `@` in the editor to fuzzy-search files, or pass files on the command line:
+
+```bash
+knightcode @README.md "Summarize this"
+knightcode @src/app.ts @src/app.test.ts "Review these together"
+```
+
+Images or text can be pasted with Ctrl+V (Alt+V on Windows); images can also be dragged into supported terminals.
+
+### Run shell commands
+
+In interactive mode:
+
+```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.
+
+### Switch models
+
+Use `/model` or Ctrl+L to choose a model for the current session. Press 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 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.
+
+### Continue later
+
+Sessions are saved automatically:
+
+```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
+```
+
+Inside knightcode, use `/resume`, `/new`, `/tree`, `/fork`, and `/clone` to manage sessions.
+
+### Non-interactive mode
+
+For one-shot prompts:
+
+```bash
+knightcode -p "Summarize this codebase"
+cat README.md | knightcode -p "Summarize this text"
+knightcode -p @screenshot.png "What's in this image?"
+```
+
+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).