{ "generated": "2026-08-24", "platforms": 23, "commands": 903, "data": { "claude_code": { "name": "Claude Code", "icon": "fas fa-terminal", "source": { "name": "Claude Code Docs — Commands reference", "url": "https://code.claude.com/docs/en/commands" }, "categories": [ { "name": "Built-in Slash Commands", "shortcuts": [ { "keys": "/add-dir ", "desc": "Add a working directory for file access during the current session", "usage": "Type a partial path to see matching directory suggestions; press Tab to accept one. Most .claude/ configuration is not discovered from the added directory." }, { "keys": "/advisor model|off", "desc": "Enable or disable the advisor tool, which consults a second model for guidance at key moments during a task", "usage": "Accepts fable, opus, sonnet, or a full model ID. fable requires Fable 5 access." }, { "keys": "/agents", "desc": "As of v2.1.198, running /agents prints a reminder to ask Claude to create or manage subagents, or to edit .claude/agents/ or...", "usage": "On v2.1.197 and earlier, opens an interactive interface for creating and managing subagent configurations" }, { "keys": "/autocompact auto|", "desc": "Set the auto-compact window: how full the context window gets before Claude Code compacts automatically", "usage": "Pass a size such as 500k, or auto to return to the window tuned for your model. Claude Code saves the value to user settings and applies it to the current session." }, { "keys": "/autofix-pr prompt", "desc": "Spawn a Claude Code on the web session that watches the current branch's PR and pushes fixes when CI fails or reviewers leave comments", "usage": "Detects the open PR from your checked-out branch with gh pr view; to watch a different PR, check out its branch first. By default the cloud session is told to fix every CI failure and review..." }, { "keys": "/background prompt", "desc": "Detach the current session to run as a background agent and free this terminal", "usage": "Pass a prompt to send one more instruction before detaching. Monitor the session with claude agents." }, { "keys": "/batch ", "desc": "Skill. Orchestrate large-scale changes across a codebase in parallel", "usage": "Researches the codebase, decomposes the work into 5 to 30 independent units, and presents a plan. Once approved, spawns one background subagent per unit in an isolated git worktree." }, { "keys": "/branch name", "desc": "Create a branch of the current conversation at this point, so you can try a different direction without losing the conversation as it stands", "usage": "Switches you into the branch and preserves the original, which you can return to with /resume. To run a copy as a separate background session instead of switching into it, use /fork; to hand a..." }, { "keys": "/btw question", "desc": "Ask a side question about the current session without adding to the conversation", "usage": "If you run /btw without a question, Claude Code shows your most recent side question so you can browse earlier answers; if you haven't asked one yet, Claude Code prints a usage line. Before..." }, { "keys": "/bug report", "desc": "Report a bug or share your conversation", "usage": "You choose how much session history to include and confirm on a consent screen before anything is sent. When you're signed in to Anthropic on a first-party connection, the report goes to..." }, { "keys": "/cd ", "desc": "Move this session to a new working directory, keeping the conversation and its prompt cache", "usage": "Type a partial path to see matching directory suggestions; press Tab to accept one. Claude Code prompts you to trust the workspace if you haven't worked in it before, and --resume finds the moved..." }, { "keys": "/chrome", "desc": "Configure Claude in Chrome settings", "usage": "Type the command in the Claude Code prompt." }, { "keys": "/claude-api migrate|managed-agents-onboard|prompt-audit", "desc": "Skill. Load Claude API and Managed Agents reference material for your project's language", "usage": "Also activates automatically when your code imports anthropic or @anthropic-ai/sdk. Run migrate to upgrade existing Claude API code to a newer model, managed-agents-onboard for a walkthrough that..." }, { "keys": "/clear name", "desc": "Start a new conversation with empty context", "usage": "Pass a name to label the previous conversation in the /resume picker. To free up context while continuing the same conversation, use /compact instead." }, { "keys": "/code-review low|medium|high|xhigh|max|ultra --fix --comment pr#|branch|path", "desc": "Skill. Review the current diff, or a PR number, branch, or path you pass, for correctness bugs and cleanup opportunities", "usage": "Pass --fix to apply findings, --comment to post them as inline GitHub PR comments, or ultra to run a deep cloud review. With ultra on a github.com PR target, --post preselects posting the finished..." }, { "keys": "/color color|default", "desc": "Set the prompt bar color for the current session", "usage": "Available colors: red, blue, green, yellow, purple, orange, pink, cyan. Use default to reset, or run with no argument to pick a random color." }, { "keys": "/compact instructions", "desc": "Free up context by summarizing the conversation so far", "usage": "Optionally pass focus instructions for the summary. See how compaction handles rules, skills, and memory files" }, { "keys": "/config key=value ...", "desc": "Open the Settings interface to adjust theme, model, output style, and other preferences", "usage": "From v2.1.181, pass one or more key=value pairs to set a setting directly without opening the interface, for example /config thinking=false. From v2.1.182, named shorthand keys are also accepted,..." }, { "keys": "/context all", "desc": "Visualize current context usage as a colored grid", "usage": "Shows optimization suggestions for context-heavy tools, memory bloat, and capacity warnings. When the conversation exceeds the context window, the output includes a warning showing how far over..." }, { "keys": "/copy N", "desc": "Copy the last assistant response to clipboard", "usage": "Pass a number N to copy the Nth-latest response: /copy 2 copies the second-to-last. When code blocks are present, shows an interactive picker to select individual blocks or the full response." }, { "keys": "/cost", "desc": "Alias for /usage", "usage": "Type the command in the Claude Code prompt." }, { "keys": "/dataviz request", "desc": "Skill. Design guidance for charts, graphs, and dashboards", "usage": "Claude picks the chart form for the data, assigns color by role, validates the palette for colorblind safety and contrast with a bundled script, and applies mark, interaction, and accessibility..." }, { "keys": "/debug description", "desc": "Skill. Enable debug logging for the current session and troubleshoot issues by reading the session debug log", "usage": "Debug logging is off by default unless you started with claude --debug, so running /debug mid-session starts capturing logs from that point forward. Optionally describe the issue to focus the analysis" }, { "keys": "/deep-research ", "desc": "Workflow. Fan out web searches on a question, fetch and cross-check sources, and synthesize a cited report", "usage": "Type the command in the Claude Code prompt." }, { "keys": "/design-login", "desc": "Authorize design-system access for /design-sync with your claude.ai account", "usage": "Type the command in the Claude Code prompt." }, { "keys": "/design-sync hint", "desc": "Skill. Convert your repo's React design system and upload it to Claude Design, so designs it produces use your real components", "usage": "Optionally name the design system, for example /design-sync Acme DS. A first-time sync verifies every component and can take a few hours on a large repo." }, { "keys": "/desktop", "desc": "Continue the current session in the Claude Code Desktop app", "usage": "Requires macOS or x64 Windows and a Claude subscription. Alias: /app" }, { "keys": "/diff", "desc": "Open an interactive diff viewer showing uncommitted changes and per-turn diffs", "usage": "Use left/right arrows to switch between the current git diff and individual Claude turns, and up/down to browse files. Press Enter to open the selected file's diff, scroll it with up/down or..." }, { "keys": "/doctor", "desc": "Skill. Run a setup checkup that diagnoses issues and can fix them", "usage": "Checks installation health, including duplicate or leftover installs, PATH problems, and unparseable settings files. Finds unused skills, MCP servers, and plugins versus their context cost, flags..." }, { "keys": "/effort level|auto", "desc": "Set the model effort level", "usage": "Accepts low, medium, high, xhigh, max, or ultracode; available levels depend on the model, and max and ultracode are session-only. auto resets to the model default." }, { "keys": "/exit", "desc": "Exit the CLI", "usage": "In an attached background session, this detaches and the session keeps running. Alias: /quit" }, { "keys": "/export filename", "desc": "Export the current conversation as plain text", "usage": "With a filename, writes directly to that file. Without, opens a dialog to copy to clipboard or save to a file" }, { "keys": "/fast on|off", "desc": "Toggle fast mode on or off", "usage": "Availability in non-interactive mode with -p is limited; see Toggle fast mode. Requires Claude Code v2.1.205 or later" }, { "keys": "/feedback report", "desc": "Send product feedback about Claude Code", "usage": "Opens the same dialog as /bug, with the same consent step, sending rules, and mid-turn behavior" }, { "keys": "/fewer-permission-prompts", "desc": "Skill. Scan your transcripts for common read-only Bash and MCP tool calls, then add a prioritized allowlist to project...", "usage": "Type the command in the Claude Code prompt." }, { "keys": "/focus", "desc": "Toggle the focus view, which shows only your last prompt, a one-line tool-call summary with edit diffstats, and the final response", "usage": "The tool-call summary also counts the subagents launched in the turn and collapses completed background-task notifications into a single count. The selection persists across sessions; set viewMode..." }, { "keys": "/fork prompt", "desc": "Copy the current conversation into a new background session and keep working here", "usage": "Pass a prompt and the copy starts working on it immediately; without one it waits in agent view for its first prompt. Except when the copy edits in place, Claude Code instructs it to create a..." }, { "keys": "/goal condition|clear", "desc": "Set a goal: Claude keeps working across turns until the condition is met or the goal clears for another reason", "usage": "With no argument, shows the current or most recently achieved goal. clear, stop, off, reset, none, or cancel removes an active goal early" }, { "keys": "/heapdump", "desc": "Write a JavaScript heap snapshot and a memory breakdown to ~/Desktop, or your home directory on Linux without a Desktop folder, for...", "usage": "Attach only the -diagnostics.json file when reporting a memory issue; the .heapsnapshot contains your full conversation and credentials, so don't share it. Doesn't appear in the command menu; type..." }, { "keys": "/help", "desc": "Show help and available commands", "usage": "Type the command in the Claude Code prompt." }, { "keys": "/hooks", "desc": "View hook configurations for tool events", "usage": "Type the command in the Claude Code prompt." }, { "keys": "/ide", "desc": "Manage IDE integrations and show status", "usage": "Type the command in the Claude Code prompt." }, { "keys": "/import codex|gemini --dry-run --yes", "desc": "Bring configuration from other coding agents on your machine, currently OpenAI Codex and Google Gemini CLI, into Claude Code, including...", "usage": "In non-interactive mode with -p, /import lists what it found and gives you the command that confirms the import. Add --dry-run to preview without writing anything, or --yes to skip the interactive..." }, { "keys": "/init", "desc": "Initialize project with a CLAUDE.md guide", "usage": "Set CLAUDE_CODE_NEW_INIT=1 for an interactive flow that also walks through skills, hooks, and personal memory files. If /init finds configuration from a coding agent that /import supports, it..." }, { "keys": "/insights", "desc": "Generate an HTML report analyzing your recent sessions on this machine: which projects you work in, how you use Claude Code, where...", "usage": "Not available in cloud sessions. See Analyze your usage patterns for the report location, retention, and cost" }, { "keys": "/install-github-app", "desc": "Install the Claude GitHub App for a repository, with an optional step to set up GitHub Actions workflows and secrets", "usage": "Walks you through selecting a repo and configuring the integration" }, { "keys": "/install-slack-app", "desc": "Install the Claude Slack app", "usage": "Opens a browser to complete the OAuth flow" }, { "keys": "/keybindings", "desc": "Open your keyboard shortcuts file", "usage": "Type the command in the Claude Code prompt." }, { "keys": "/list-agents", "desc": "List the subagents and other Claude Code sessions Claude can message, with the name to use for each; agent team teammates aren't listed,...", "usage": "See cross-session messaging. Also available as /peers." }, { "keys": "/login", "desc": "Sign in to your Anthropic account", "usage": "Type the command in the Claude Code prompt." }, { "keys": "/logout", "desc": "Sign out from your Anthropic account", "usage": "Type the command in the Claude Code prompt." }, { "keys": "/loop interval prompt", "desc": "Skill. Run a prompt repeatedly while the session stays open", "usage": "Omit the interval and, where available, Claude self-paces between iterations. Omit the prompt and, where available, Claude runs an autonomous maintenance check or the prompt in .claude/loop.md." }, { "keys": "/mcp reconnect |enable|disable |all", "desc": "Manage MCP server connections and OAuth authentication", "usage": "Run with no argument to open the interactive list, pass reconnect to reconnect one disconnected server, or pass enable/disable with a server name or all to change connection state without..." }, { "keys": "/memory", "desc": "Edit CLAUDE.md files, enable or disable auto memory, and view auto memory entries", "usage": "Type the command in the Claude Code prompt." }, { "keys": "/mobile", "desc": "Show QR code to download the Claude mobile app", "usage": "Aliases: /ios, /android" }, { "keys": "/model model", "desc": "Switch the AI model and save it as your default for new sessions", "usage": "For models that support it, use left/right arrows to adjust effort level. With no argument, opens a picker; press s on a row to switch for the current session only." }, { "keys": "/passes", "desc": "Share a free week of Claude Code with friends", "usage": "Only visible if your account is eligible" }, { "keys": "/permissions", "desc": "Manage allow, ask, and deny rules for tool permissions", "usage": "Opens an interactive dialog where you can view rules by scope, add or remove rules, manage working directories, and review recent auto mode denials. When you run it while Claude is responding,..." }, { "keys": "/plan description", "desc": "Enter plan mode directly from the prompt", "usage": "Pass an optional description to enter plan mode and immediately start with that task, for example /plan fix the auth bug" }, { "keys": "/plugin subcommand", "desc": "Manage Claude Code plugins", "usage": "Run with no argument to open the plugin menu, or pass a subcommand such as list, install, enable, or disable to act directly. Claude Code can activate a plugin during the install; the install..." }, { "keys": "/powerup", "desc": "Discover Claude Code features through quick interactive lessons with animated demos", "usage": "Type the command in the Claude Code prompt." }, { "keys": "/pr-comments PR", "desc": "Removed in v2.1.91", "usage": "Ask Claude directly to view pull request comments instead. On earlier versions, fetches and displays comments from a GitHub pull request; automatically detects the PR for the current branch, or..." }, { "keys": "/privacy-settings", "desc": "View and update your privacy settings", "usage": "Only available for Pro and Max plan subscribers" }, { "keys": "/radio", "desc": "Open Claude FM lo-fi radio in your browser", "usage": "Prints the stream URL when no browser is available. Not available on Amazon Bedrock, Google Cloud's Agent Platform, Microsoft Foundry, or Claude Platform on AWS" }, { "keys": "/recap", "desc": "Generate a one-line summary of the current session on demand", "usage": "See Session recap for the automatic recap that appears after you've been away" }, { "keys": "/release-notes", "desc": "View the changelog in an interactive version picker", "usage": "Select a specific version to see its release notes, or choose to show all versions. The notes appear in your transcript without entering the conversation Claude sees" }, { "keys": "/reload-plugins --force", "desc": "Reload all active plugins to apply pending changes without restarting", "usage": "Reports counts for each reloaded component and flags any load errors. When the reload would change which MCP tools are loaded and invalidate the prompt cache, the command warns and skips unless..." }, { "keys": "/reload-skills", "desc": "Re-scan skill and command directories so skills added or changed on disk during the session become available without restarting", "usage": "Reports how many skills are available and how many were added or removed. Added in v2.1.152" }, { "keys": "/remote-control", "desc": "Make this session available for Remote Control from claude.ai", "usage": "Running it while signed out prints that Remote Control requires a claude.ai subscription and tells you how to sign in; before v2.1.206 it reported Unknown command: /remote-control. Alias: /rc" }, { "keys": "/remote-env", "desc": "Choose the default environment for cloud agents", "usage": "Type the command in the Claude Code prompt." }, { "keys": "/rename name", "desc": "Rename the current session and show the name on the prompt bar", "usage": "Without a name, auto-generates one from conversation history. Also available in non-interactive mode (-p); requires Claude Code v2.1.205 or later." }, { "keys": "/resume session", "desc": "Resume a conversation by ID or name, or open the session picker", "usage": "Background sessions appear in the picker marked with bg; one that is still running can't be resumed here, so attach to it from claude agents or stop it there first. Alias: /continue" }, { "keys": "/review low|medium|high|xhigh|max|ultra --fix --comment pr#|branch|path", "desc": "Alias of /code-review: reviews the current diff, or a PR number, branch, or path you pass, such as /review 1234, and takes the same...", "usage": "With no level given, the review reuses the last low through max level you typed; see Review a diff locally for the exact rules. For a deep cloud review, use /code-review ultra." }, { "keys": "/rewind", "desc": "Rewind the conversation and/or code to a previous point, or summarize from a selected message", "usage": "See checkpointing. Aliases: /checkpoint, /undo" }, { "keys": "/run", "desc": "Skill. Launch and drive your project's app to see a change working, not only passing tests", "usage": "See Run and verify your app. Requires Claude Code v2.1.145 or later" }, { "keys": "/run-skill-generator", "desc": "Skill. Teach /run and /verify how to build, launch, and drive your project's app from a clean environment by writing a per-project skill", "usage": "Requires Claude Code v2.1.145 or later" }, { "keys": "/sandbox", "desc": "Toggle sandbox mode", "usage": "Available on supported platforms only" }, { "keys": "/schedule description", "desc": "Create, update, list, or run routines, which execute in the cloud", "usage": "Claude walks you through the setup conversationally. You can also ask about a routine's recent runs." }, { "keys": "/scroll-speed", "desc": "Adjust mouse wheel scroll speed interactively, with a ruler you can scroll while the dialog is open to preview the change", "usage": "Available in fullscreen rendering only and not in the JetBrains IDE terminal" }, { "keys": "/security-review", "desc": "Analyze the changes on your current branch for security vulnerabilities", "usage": "Reviews the diff between your branch and origin's default branch, identifying risks like injection, auth issues, and data exposure. Needs an origin remote; if the review fails with an ambiguous..." }, { "keys": "/setup-bedrock", "desc": "Configure Amazon Bedrock authentication, region, and model pins through an interactive wizard", "usage": "Only visible when CLAUDE_CODE_USE_BEDROCK=1 is set. First-time Amazon Bedrock users can also access this wizard from the login screen" }, { "keys": "/setup-vertex", "desc": "Configure Google Cloud's Agent Platform authentication, project, region, and model pins through an interactive wizard", "usage": "Only visible when CLAUDE_CODE_USE_VERTEX=1 is set. First-time Google Cloud's Agent Platform users can also access this wizard from the login screen" }, { "keys": "/simplify target", "desc": "Skill. Review the changed code for cleanup opportunities and apply the fixes", "usage": "Four review agents run in parallel, covering reuse of existing helpers, simplification, efficiency, and whether the change is at the right level of abstraction. From v2.1.154, the review doesn't..." }, { "keys": "/skills", "desc": "List available skills", "usage": "Type to filter the list by name. Press t to sort by token count." }, { "keys": "/stats", "desc": "Alias for /usage", "usage": "Opens on the Stats tab" }, { "keys": "/status", "desc": "Open the Settings interface on the Status tab, showing version, model, account, and connectivity", "usage": "A Session kind row reads background job · attached or background job · unattended in a background session, depending on whether a terminal is attached, and interactive in any other session. Before..." }, { "keys": "/statusline", "desc": "Configure Claude Code's status line", "usage": "Describe what you want, or run without arguments to auto-configure from your shell prompt" }, { "keys": "/stickers", "desc": "Order Claude Code stickers", "usage": "Type the command in the Claude Code prompt." }, { "keys": "/stop", "desc": "Stop the current background session", "usage": "Only available while attached to a background session; the transcript and any worktree are kept. To detach without stopping, use /exit or press ←" }, { "keys": "/subtask ", "desc": "Spawn a forked subagent: a background subagent that inherits the full conversation and works on the task while you keep working", "usage": "Its result returns to this conversation when it finishes. To copy the conversation into a separate background session instead, use /fork." }, { "keys": "/tasks", "desc": "View and manage background work in the current session, including subagents that have finished", "usage": "Also available as /bashes" }, { "keys": "/team-onboarding", "desc": "Generate a team onboarding guide from your Claude Code usage history", "usage": "Claude analyzes your sessions, commands, and MCP server usage from the past 30 days and produces a markdown guide a teammate can paste as a first message to get set up quickly. For claude.ai..." }, { "keys": "/teleport", "desc": "Pull a Claude Code on the web session into this terminal", "usage": "Opens a picker, then fetches the branch and conversation. Also available as /tp." }, { "keys": "/terminal-setup", "desc": "Configure terminal keybindings for Shift+Enter and other shortcuts", "usage": "Only visible in terminals that need it, like VS Code, Cursor, Devin Desktop, Alacritty, or Zed" }, { "keys": "/theme", "desc": "Change the color theme", "usage": "Includes an auto option that matches your terminal's light or dark background, light and dark variants, colorblind-accessible (daltonized) themes, ANSI themes that use your terminal's color..." }, { "keys": "/tui default|fullscreen", "desc": "Set the terminal UI renderer and relaunch into it with your conversation intact", "usage": "fullscreen enables the flicker-free alt-screen renderer. With no argument, prints the active renderer" }, { "keys": "/ultraplan ", "desc": "Removed", "usage": "Use plan mode instead. Previously sent a planning task to a Claude Code on the web session for review in your browser" }, { "keys": "/ultrareview PR or branch", "desc": "Run a deep, multi-agent code review in a cloud sandbox with ultrareview", "usage": "Pass a PR reference to review that pull request, or a branch name to change the comparison base. The preferred invocation is now /code-review ultra, and /ultrareview remains as an alias." }, { "keys": "/upgrade", "desc": "Open the upgrade page in your browser to switch to a higher plan tier", "usage": "When the browser fails to open, the command shows a sign-in prompt without printing the URL" }, { "keys": "/usage", "desc": "Show session cost, plan usage limits, and activity stats", "usage": "On a Pro, Max, Team, or Enterprise plan, includes a breakdown of usage by skill, subagent, plugin, and MCP server. See the cost tracking guide for details." }, { "keys": "/usage-credits", "desc": "Configure usage credits, or request them from your admin, when you hit a limit", "usage": "Opens your usage-credits billing settings in the browser, except that Team and Enterprise members without billing access instead send a usage-credits request to their admin from the CLI, after..." }, { "keys": "/verify", "desc": "Skill. Confirm a code change does what it should by building your project's app, running it, and observing the result, rather than...", "usage": "See Run and verify your app. Requires Claude Code v2.1.145 or later" }, { "keys": "/vim", "desc": "Removed in v2.1.92", "usage": "To toggle between Vim and Normal editing modes, use /config → Editor mode" }, { "keys": "/voice hold|tap|off", "desc": "Toggle voice dictation, or enable it in a specific mode", "usage": "Requires a Claude.ai account" }, { "keys": "/web-setup", "desc": "Connect your GitHub account to Claude Code on the web using your local gh CLI credentials", "usage": "/schedule prompts for this automatically if GitHub isn't connected" }, { "keys": "/workflows", "desc": "Open the workflow progress view to watch, pause, resume, or save running and completed workflows", "usage": "Type the command in the Claude Code prompt." } ] }, { "name": "Prompt Input Prefixes", "shortcuts": [ { "keys": "/ (at start)", "desc": "Run a command or skill", "usage": "Shows built-in commands, skills, and plugin or MCP commands as you type." }, { "keys": "! (at start)", "desc": "Shell mode: run a command directly", "usage": "Adds its output to the session so Claude can respond to it." }, { "keys": "@", "desc": "File path mention with autocomplete", "usage": "Can also suggest other live sessions for cross-session messaging." }, { "keys": ":name:", "desc": "Insert an emoji by shortcode", "usage": "Two or more characters after the colon shows suggestions." }, { "keys": "? (empty input)", "desc": "Toggle the shortcut help panel", "usage": "Typing ? with text present inserts the character instead." } ] }, { "name": "Hook Events", "shortcuts": [ { "keys": "SessionStart", "desc": "When a session begins or resumes", "usage": "Matcher filters how the session started: startup, resume, clear, compact, fork." }, { "keys": "Setup", "desc": "When you start Claude Code with --init-only, or with --init or --maintenance in -p mode", "usage": "For one-time preparation in CI or scripts. Matcher values: init, maintenance." }, { "keys": "UserPromptSubmit", "desc": "When you submit a prompt, before Claude processes it", "usage": "No matcher support - fires on every prompt." }, { "keys": "UserPromptExpansion", "desc": "When a user-typed command expands into a prompt, before it reaches Claude", "usage": "Can block the expansion. Matcher filters by your skill or command names." }, { "keys": "PreToolUse", "desc": "Before a tool call executes; can block it", "usage": "Matcher filters by tool name, e.g. Bash, Edit|Write, mcp__.*" }, { "keys": "PermissionRequest", "desc": "When a tool call needs a permission decision", "usage": "Matcher filters by tool name, same values as PreToolUse." }, { "keys": "PermissionDenied", "desc": "When auto mode denies a tool call, including denials without a classifier verdict", "usage": "hookSpecificOutput.retry: true tells the model it may retry; ignored when the classifier produced no verdict." }, { "keys": "PostToolUse", "desc": "After a tool call succeeds", "usage": "Matcher filters by tool name." }, { "keys": "PostToolUseFailure", "desc": "After a tool call fails", "usage": "Matcher filters by tool name." }, { "keys": "PostToolBatch", "desc": "After a full batch of parallel tool calls resolves, before the next model call", "usage": "No matcher support." }, { "keys": "Notification", "desc": "When Claude Code sends a notification", "usage": "Matcher filters by notification type, e.g. permission_prompt, idle_prompt, agent_needs_input, agent_completed." }, { "keys": "MessageDisplay", "desc": "While assistant message text is displayed", "usage": "Display-only event; no matcher support." }, { "keys": "SubagentStart", "desc": "When a subagent is spawned", "usage": "Matcher filters by agent type: general-purpose, Explore, Plan, custom or plugin-scoped agent names." }, { "keys": "SubagentStop", "desc": "When a subagent finishes", "usage": "Same matcher values as SubagentStart." }, { "keys": "TaskCreated", "desc": "When a task is being created via TaskCreate", "usage": "No matcher support." }, { "keys": "TaskCompleted", "desc": "When a task is being marked as completed", "usage": "No matcher support." }, { "keys": "Stop", "desc": "When Claude finishes responding", "usage": "No matcher support. Claude Code overrides a Stop hook after it blocks eight times in a row without progress." }, { "keys": "StopFailure", "desc": "When the turn ends due to an API error", "usage": "Matcher filters by error type, e.g. rate_limit, overloaded, server_error, max_output_tokens." }, { "keys": "TeammateIdle", "desc": "When an agent team teammate is about to go idle", "usage": "No matcher support." }, { "keys": "InstructionsLoaded", "desc": "When a CLAUDE.md or .claude/rules/*.md file is loaded into context", "usage": "Fires at session start and on lazy loads. Matcher values include session_start, nested_traversal, include, compact." }, { "keys": "ConfigChange", "desc": "When a configuration file changes during a session", "usage": "Matcher filters by source: user_settings, project_settings, local_settings, policy_settings, skills." }, { "keys": "CwdChanged", "desc": "When the working directory changes, for example when Claude executes a cd command", "usage": "No matcher support - fires on every directory change." }, { "keys": "DirectoryAdded", "desc": "When a working directory is added mid-session via /add-dir or the SDK register_repo_root request", "usage": "Matcher values: slash_command, register_repo_root." }, { "keys": "FileChanged", "desc": "When a watched file changes on disk", "usage": "The matcher field specifies literal filenames to watch, e.g. .envrc|.env" }, { "keys": "WorktreeCreate", "desc": "When a worktree is being created via --worktree, isolation: worktree, or for a background session", "usage": "Replaces default git behavior. No matcher support." }, { "keys": "WorktreeRemove", "desc": "When a worktree is being removed at session exit, when a subagent finishes, or when you delete a background session", "usage": "No matcher support." }, { "keys": "PreCompact", "desc": "Before context compaction", "usage": "Matcher filters what triggered compaction: manual, auto." }, { "keys": "PostCompact", "desc": "After context compaction completes", "usage": "Matcher values: manual, auto." }, { "keys": "Elicitation", "desc": "When an MCP server requests user input during a tool call", "usage": "Matcher filters by your configured MCP server names." }, { "keys": "ElicitationResult", "desc": "After a user responds to an MCP elicitation, before the response is sent back to the server", "usage": "Same matcher values as Elicitation." }, { "keys": "SessionEnd", "desc": "When a session terminates", "usage": "Matcher filters why the session ended: clear, resume, logout, prompt_input_exit, other." } ] } ] }, "cursor": { "name": "Cursor", "icon": "fas fa-i-cursor", "source": { "name": "Cursor Docs — CLI slash commands & Prompting agents", "url": "https://cursor.com/docs/cli/reference/slash-commands" }, "categories": [ { "name": "CLI Slash Commands", "shortcuts": [ { "keys": "/model [filter]", "desc": "Select a model. Press Tab to edit", "usage": "Type it at the start of the cursor-agent CLI prompt." }, { "keys": "/run-everything [on|off|status]", "desc": "Toggle Run Everything or show its status", "usage": "Also: /auto-run. Type it at the start of the cursor-agent CLI prompt." }, { "keys": "/plan [prompt]", "desc": "Switch to Plan mode, show the current plan, or submit a prompt in Plan mode", "usage": "Type it at the start of the cursor-agent CLI prompt." }, { "keys": "/ask", "desc": "Toggle Ask mode for read-only questions", "usage": "Type it at the start of the cursor-agent CLI prompt." }, { "keys": "/debug [prompt]", "desc": "Toggle Debug mode or submit a prompt in Debug mode", "usage": "Type it at the start of the cursor-agent CLI prompt." }, { "keys": "/goal [objective]", "desc": "Give the agent a long-lived objective to work towards until it's fully complete. Rolling out", "usage": "Type it at the start of the cursor-agent CLI prompt." }, { "keys": "/logs", "desc": "Show the debug log path and copy it to the clipboard", "usage": "Type it at the start of the cursor-agent CLI prompt." }, { "keys": "/update", "desc": "Update Cursor Agent to the latest version", "usage": "Type it at the start of the cursor-agent CLI prompt." }, { "keys": "/max-mode", "desc": "Toggle Max Mode on legacy request-based plans", "usage": "Type it at the start of the cursor-agent CLI prompt." }, { "keys": "/rename ", "desc": "Rename the current chat session", "usage": "Type it at the start of the cursor-agent CLI prompt." }, { "keys": "/clear", "desc": "Start a new chat session", "usage": "Also: /new, /new-chat, /newchat. Type it at the start of the cursor-agent CLI prompt." }, { "keys": "/resume", "desc": "Open recent chats and resume one", "usage": "Type it at the start of the cursor-agent CLI prompt." }, { "keys": "/fork", "desc": "Fork the current chat into a new session", "usage": "Type it at the start of the cursor-agent CLI prompt." }, { "keys": "/summarize", "desc": "Summarize the conversation to reduce context", "usage": "Also: /compress. Type it at the start of the cursor-agent CLI prompt." }, { "keys": "/rewind", "desc": "Jump back to a previous message", "usage": "Type it at the start of the cursor-agent CLI prompt." }, { "keys": "/vim", "desc": "Toggle Vim keys", "usage": "Type it at the start of the cursor-agent CLI prompt." }, { "keys": "/line-numbers", "desc": "Toggle line numbers in code blocks", "usage": "Type it at the start of the cursor-agent CLI prompt." }, { "keys": "/show-thinking", "desc": "Toggle thinking block display", "usage": "Type it at the start of the cursor-agent CLI prompt." }, { "keys": "/status-indicators", "desc": "Toggle terminal title status indicators", "usage": "Type it at the start of the cursor-agent CLI prompt." }, { "keys": "/shell [command]", "desc": "Enter Shell Mode", "usage": "Also: /sh, /run. Type it at the start of the cursor-agent CLI prompt." }, { "keys": "/about", "desc": "Show CLI version, system, and account info. Also copies it to the clipboard", "usage": "Type it at the start of the cursor-agent CLI prompt." }, { "keys": "/setup-terminal", "desc": "Configure terminal newline keybindings. See Terminal setup", "usage": "Type it at the start of the cursor-agent CLI prompt." }, { "keys": "/help [command]", "desc": "Show help. Use", "usage": "Type it at the start of the cursor-agent CLI prompt." }, { "keys": "/help ", "desc": "for command details", "usage": "Type it at the start of the cursor-agent CLI prompt." }, { "keys": "/feedback ", "desc": "Share feedback with the team", "usage": "Type it at the start of the cursor-agent CLI prompt." }, { "keys": "/open", "desc": "Open the repository's Git root in Cursor", "usage": "Also: /cursor. Type it at the start of the cursor-agent CLI prompt." }, { "keys": "/copy-request-id", "desc": "Copy the last request ID to the clipboard", "usage": "Type it at the start of the cursor-agent CLI prompt." }, { "keys": "/copy-conversation-id", "desc": "Copy the current conversation ID to the clipboard", "usage": "Type it at the start of the cursor-agent CLI prompt." }, { "keys": "/logout", "desc": "Sign out from Cursor", "usage": "Type it at the start of the cursor-agent CLI prompt." } ] }, { "name": "@ Mentions & Prompt Input", "shortcuts": [ { "keys": "@", "desc": "Attach a specific file to your prompt", "usage": "Example: @auth.ts. Start typing after @ for suggestions." }, { "keys": "@/", "desc": "Attach a folder; type / after selecting to navigate deeper", "usage": "Example: @src/components/." }, { "keys": "@Terminals", "desc": "Include terminal output as context", "usage": "Attaches recent terminal content to the prompt." }, { "keys": "@Chats", "desc": "Reference context from a previous conversation", "usage": "Pulls a past chat into the current prompt." }, { "keys": "@Commit", "desc": "Attach the diff of your uncommitted working state", "usage": "Listed as Commit (Diff of Working State)." }, { "keys": "@Branch", "desc": "Attach the full diff of your branch against main", "usage": "Listed as Branch (Diff with Main)." }, { "keys": "@Browser", "desc": "Attach context from the built-in browser", "usage": "Bring page state into the conversation." }, { "keys": "/", "desc": "Invoke a skill from the chat input", "usage": "Press Enter to attach it to one message; use Custom Modes to keep it active." } ] } ] }, "copilot": { "name": "GitHub Copilot", "icon": "fab fa-github", "source": { "name": "GitHub Docs — Copilot Chat cheat sheet", "url": "https://docs.github.com/en/copilot/reference/chat-cheat-sheet" }, "categories": [ { "name": "Slash Commands & Prompts (VS Code)", "shortcuts": [ { "keys": "/clear", "desc": "Start a new chat session", "usage": "Clears the current Copilot Chat conversation in VS Code." }, { "keys": "/explain", "desc": "Explain how the code in your active editor works", "usage": "Select code first for a focused explanation." }, { "keys": "/fix", "desc": "Propose a fix for problems in the selected code", "usage": "Highlight the broken code, then run the command." }, { "keys": "/fixTestFailure", "desc": "Find and fix a failing test", "usage": "Copilot locates the failing test and proposes a repair." }, { "keys": "/help", "desc": "Quick reference and basics of using GitHub Copilot", "usage": "Lists available commands and usage basics." }, { "keys": "/new", "desc": "Create a new project", "usage": "Scaffolds a new workspace from your description." }, { "keys": "/tests", "desc": "Generate unit tests for the selected code", "usage": "Select a function or class before running." } ] }, { "name": "Chat Variables (#) Prompts (VS Code)", "shortcuts": [ { "keys": "#block", "desc": "Include the current block of code in the prompt", "usage": "Type # in the chat box, then the variable name." }, { "keys": "#class", "desc": "Include the current class in the prompt", "usage": "Scopes the context to the enclosing class." }, { "keys": "#comment", "desc": "Include the current comment in the prompt", "usage": "Useful when iterating on a doc comment." }, { "keys": "#file", "desc": "Include the current file's content in the prompt", "usage": "Attaches the whole active file as context." }, { "keys": "#function", "desc": "Include the current function or method in the prompt", "usage": "Scopes the context to the enclosing function." }, { "keys": "#line", "desc": "Include the current line of code in the prompt", "usage": "Narrowest context scope available." }, { "keys": "#path", "desc": "Include the file path in the prompt", "usage": "Passes the location, not the contents." }, { "keys": "#project", "desc": "Include the project context in the prompt", "usage": "Broadest scope; slower but most informed." }, { "keys": "#selection", "desc": "Include the currently selected text in the prompt", "usage": "Select first, then reference #selection." }, { "keys": "#sym", "desc": "Include the current symbol in the prompt", "usage": "Targets the symbol under the cursor." } ] }, { "name": "Chat Participants (@) Prompts", "shortcuts": [ { "keys": "@azure", "desc": "Context about Azure services: use, deploy, and manage them", "usage": "Public preview; subject to change." }, { "keys": "@github", "desc": "Use GitHub-specific Copilot skills", "usage": "Bridges chat to GitHub skills from the IDE." }, { "keys": "@terminal", "desc": "Context about the VS Code terminal shell and its contents", "usage": "Ask it to create or debug terminal commands." }, { "keys": "@vscode", "desc": "Context about VS Code commands and features", "usage": "Ask how to do something in the editor itself." } ] }, { "name": "Slash Commands (GitHub.com Chat)", "shortcuts": [ { "keys": "/clear", "desc": "Clear conversation (GitHub.com)", "usage": "Runs in Copilot Chat on the GitHub website." }, { "keys": "/delete", "desc": "Delete a conversation", "usage": "Removes the conversation from your history." }, { "keys": "/new", "desc": "Start a new conversation (GitHub.com)", "usage": "Opens a fresh chat thread." }, { "keys": "/rename", "desc": "Rename a conversation", "usage": "Give threads descriptive names for later." } ] }, { "name": "Slash Commands (Visual Studio & Xcode)", "shortcuts": [ { "keys": "/doc", "desc": "Add a documentation comment for this symbol", "usage": "Cursor must be on the symbol to document." }, { "keys": "/optimize", "desc": "Analyze and improve running time of the selected code", "usage": "Select the hot path first." }, { "keys": "/simplify", "desc": "Simplify the current code selection", "usage": "Available in Copilot for Xcode." } ] }, { "name": "Slash Commands (JetBrains & Copilot CLI)", "shortcuts": [ { "keys": "/chronicle", "desc": "Review and analyze your session history", "usage": "Subcommands: standup, tips, search, improve." }, { "keys": "/compact", "desc": "Compress the current Copilot CLI session context", "usage": "Keeps a long-running session manageable." }, { "keys": "/remote", "desc": "Enable or manage remote control for the current CLI session", "usage": "Access the session from GitHub.com or GitHub Mobile." } ] } ] }, "openai_codex": { "name": "OpenAI Codex CLI", "icon": "fas fa-robot", "source": { "name": "OpenAI Codex Docs", "url": "https://github.com/openai/codex/tree/main/docs" }, "categories": [ { "name": "Slash Commands", "shortcuts": [ { "keys": "/permissions", "desc": "Relax or tighten approval requirements mid-session, such as switching between Auto and Read", "usage": "Relax or tighten approval requirements mid-session, such as switching between Auto and Read." }, { "keys": "/ide", "desc": "Pull editor context into the next prompt without re-explaining what's open in your IDE", "usage": "Pull editor context into the next prompt without re-explaining what's open in your IDE." }, { "keys": "/keymap", "desc": "Inspect and persist custom shortcut bindings in config.toml", "usage": "Inspect and persist custom shortcut bindings in config.toml." }, { "keys": "/vim", "desc": "Switch between Vim normal/insert behavior and the default composer editing mode", "usage": "Switch between Vim normal/insert behavior and the default composer editing mode." }, { "keys": "/setup-default-sandbox", "desc": "Replace the degraded Windows sandbox after Codex offers the elevated setup", "usage": "Replace the degraded Windows sandbox after Codex offers the elevated setup." }, { "keys": "/sandbox-add-read-dir", "desc": "Unblock commands that need to read an absolute directory path outside the current readable", "usage": "Unblock commands that need to read an absolute directory path outside the current readable." }, { "keys": "/agent, /subagents", "desc": "Inspect or continue work in a spawned subagent thread", "usage": "Inspect or continue work in a spawned subagent thread." }, { "keys": "/apps", "desc": "Attach an app as $app-slug before asking Codex to use it", "usage": "Attach an app as $app-slug before asking Codex to use it." }, { "keys": "/plugins", "desc": "Inspect plugin tools, install suggested plugins, or manage plugin availability", "usage": "Inspect plugin tools, install suggested plugins, or manage plugin availability." }, { "keys": "/hooks", "desc": "Inspect configured hooks, trust new or changed hooks, or disable non-managed hooks before they", "usage": "Inspect configured hooks, trust new or changed hooks, or disable non-managed hooks before they." }, { "keys": "/clear", "desc": "Reset the visible UI and chat context together when you want a fresh start", "usage": "Reset the visible UI and chat context together when you want a fresh start." }, { "keys": "/rename", "desc": "Give a saved session a recognizable name without leaving the TUI", "usage": "Give a saved session a recognizable name without leaving the TUI." }, { "keys": "/archive", "desc": "Remove the current session from active session lists without deleting its transcript", "usage": "Remove the current session from active session lists without deleting its transcript." }, { "keys": "/delete", "desc": "Remove the transcript and descendant sessions when archiving isn't enough", "usage": "Remove the transcript and descendant sessions when archiving isn't enough." }, { "keys": "/compact", "desc": "Use after long runs so Codex retains key points without blowing the context window", "usage": "Use after long runs so Codex retains key points without blowing the context window." }, { "keys": "/copy", "desc": "Grab the latest finished response or plan text without manually selecting it. You can also", "usage": "Grab the latest finished response or plan text without manually selecting it. You can also." }, { "keys": "/diff", "desc": "Review Codex's edits before you commit or run tests", "usage": "Review Codex's edits before you commit or run tests." }, { "keys": "/exit", "desc": "Alternative spelling; both commands exit the session", "usage": "Alternative spelling; both commands exit the session." }, { "keys": "/experimental", "desc": "Enable options such as Network proxy or Prevent sleep while running", "usage": "Enable options such as Network proxy or Prevent sleep while running." }, { "keys": "/approve", "desc": "Retry a command or action that the auto reviewer denied", "usage": "Retry a command or action that the auto reviewer denied." }, { "keys": "/memories", "desc": "Turn memory injection or memory generation on or off without leaving the TUI", "usage": "Turn memory injection or memory generation on or off without leaving the TUI." }, { "keys": "/skills", "desc": "Improve task-specific behavior by selecting a relevant local skill", "usage": "Improve task-specific behavior by selecting a relevant local skill." }, { "keys": "/import", "desc": "Migrate supported external-agent artifacts into Codex configuration and local files", "usage": "Migrate supported external-agent artifacts into Codex configuration and local files." }, { "keys": "/feedback", "desc": "Report issues or share diagnostics with support", "usage": "Report issues or share diagnostics with support." }, { "keys": "/init", "desc": "Capture persistent instructions for the repository or subdirectory you're working", "usage": "Capture persistent instructions for the repository or subdirectory you're working." }, { "keys": "/logout", "desc": "Clear local credentials when using a shared machine", "usage": "Clear local credentials when using a shared machine." }, { "keys": "/mcp", "desc": "Check which external tools Codex can call during the session; add verbose for server details", "usage": "Check which external tools Codex can call during the session; add verbose for server details." }, { "keys": "/mention", "desc": "Point Codex at specific files or folders you want it to inspect next", "usage": "Point Codex at specific files or folders you want it to inspect next." }, { "keys": "/model", "desc": "Switch between models such as gpt-5.4-mini and gpt-5.5 before running a task", "usage": "Switch between models such as gpt-5.4-mini and gpt-5.5 before running a task." }, { "keys": "/fast", "desc": "Turn the current model's Fast tier on or off and persist the selection", "usage": "Turn the current model's Fast tier on or off and persist the selection." }, { "keys": "/plan", "desc": "Ask Codex to propose an execution plan before implementation work starts", "usage": "Ask Codex to propose an execution plan before implementation work starts." }, { "keys": "/goal", "desc": "Give Codex a persistent target to track while a larger task runs", "usage": "Give Codex a persistent target to track while a larger task runs." }, { "keys": "/personality", "desc": "Make Codex more concise, more explanatory, or more collaborative without changing your", "usage": "Make Codex more concise, more explanatory, or more collaborative without changing your." }, { "keys": "/ps", "desc": "Check long-running commands without leaving the main transcript", "usage": "Check long-running commands without leaving the main transcript." }, { "keys": "/stop", "desc": "Cancel background terminal work started by the current session", "usage": "Cancel background terminal work started by the current session." }, { "keys": "/fork", "desc": "Branch the active session to explore a new approach without losing the current transcript", "usage": "Branch the active session to explore a new approach without losing the current transcript." }, { "keys": "/app", "desc": "Move from the TUI to the desktop app on macOS or Windows", "usage": "Move from the TUI to the desktop app on macOS or Windows." }, { "keys": "/side, /btw", "desc": "Ask a focused follow-up without disrupting the main chat's transcript", "usage": "Ask a focused follow-up without disrupting the main chat's transcript." }, { "keys": "/raw", "desc": "Make terminal selection and copying less formatted while reviewing long output", "usage": "Make terminal selection and copying less formatted while reviewing long output." }, { "keys": "/resume", "desc": "Continue work from a previous CLI session without starting over", "usage": "Continue work from a previous CLI session without starting over." }, { "keys": "/new", "desc": "Reset the chat context without leaving the CLI when you want a fresh prompt in the same repo", "usage": "Reset the chat context without leaving the CLI when you want a fresh prompt in the same repo." }, { "keys": "/quit", "desc": "Leave the session immediately", "usage": "Leave the session immediately." }, { "keys": "/review", "desc": "Run after Codex completes work or when you want a second set of eyes on local changes", "usage": "Run after Codex completes work or when you want a second set of eyes on local changes." }, { "keys": "/status", "desc": "Confirm the active model, approval policy, writable roots, and remaining context capacity", "usage": "Confirm the active model, approval policy, writable roots, and remaining context capacity." }, { "keys": "/usage", "desc": "Inspect daily, weekly, or cumulative ChatGPT token activity from inside the TUI", "usage": "Inspect daily, weekly, or cumulative ChatGPT token activity from inside the TUI." }, { "keys": "/debug-config", "desc": "Debug precedence and policy requirements, including experimental network constraints", "usage": "Debug precedence and policy requirements, including experimental network constraints." }, { "keys": "/statusline", "desc": "Pick and reorder footer items (model/context/limits/git/tokens/session) and persist", "usage": "Pick and reorder footer items (model/context/limits/git/tokens/session) and persist." }, { "keys": "/title", "desc": "Pick and reorder title items such as project, status, thread, branch, model, and task progress", "usage": "Pick and reorder title items such as project, status, thread, branch, model, and task progress." }, { "keys": "/theme", "desc": "Preview and persist a terminal syntax-highlighting theme", "usage": "Preview and persist a terminal syntax-highlighting theme." }, { "keys": "/pets, /pet", "desc": "Personalize the TUI with a built-in or custom ambient pet", "usage": "Personalize the TUI with a built-in or custom ambient pet." }, { "keys": "/cloud", "desc": "Run the chat in the cloud, when cloud execution is available", "usage": "Run the chat in the cloud, when cloud execution is available." }, { "keys": "/cloud-environment", "desc": "Choose the cloud environment for the chat", "usage": "Choose the cloud environment for the chat." }, { "keys": "/ide-context", "desc": "Turn automatic IDE context on or off", "usage": "Turn automatic IDE context on or off." }, { "keys": "/local", "desc": "Run the chat in your local workspace", "usage": "Run the chat in your local workspace." }, { "keys": "/project", "desc": "Choose a project for new chats", "usage": "Choose a project for new chats." }, { "keys": "/reasoning", "desc": "Choose the reasoning effort for the current chat", "usage": "Choose the reasoning effort for the current chat." }, { "keys": "/side", "desc": "Start a temporary side chat without interrupting the main chat", "usage": "Start a temporary side chat without interrupting the main chat." }, { "keys": "/worktree", "desc": "Run the chat in a new Git worktree", "usage": "Run the chat in a new Git worktree." } ] } ] }, "aider": { "name": "Aider", "icon": "fas fa-code-branch", "source": { "name": "Aider Docs — In-chat commands", "url": "https://aider.chat/docs/usage/commands.html" }, "categories": [ { "name": "Slash Commands", "shortcuts": [ { "keys": "/add", "desc": "Add files to the chat so aider can edit them or review them in detail", "usage": "Add files to the chat so aider can edit them or review them in detail" }, { "keys": "/architect", "desc": "Enter architect/editor mode using 2 different models. If no prompt provided, switches", "usage": "Enter architect/editor mode using 2 different models. If no prompt provided, switches to architect/editor mode." }, { "keys": "/ask", "desc": "Ask questions about the code base without editing any files. If no prompt provided, switches", "usage": "Ask questions about the code base without editing any files. If no prompt provided, switches to ask mode." }, { "keys": "/chat-mode", "desc": "Switch to a new chat mode", "usage": "Switch to a new chat mode" }, { "keys": "/clear", "desc": "Clear the chat history", "usage": "Clear the chat history" }, { "keys": "/code", "desc": "Ask for changes to your code. If no prompt provided, switches to code mode", "usage": "Ask for changes to your code. If no prompt provided, switches to code mode." }, { "keys": "/commit", "desc": "Commit edits to the repo made outside the chat (commit message optional)", "usage": "Commit edits to the repo made outside the chat (commit message optional)" }, { "keys": "/context", "desc": "Enter context mode to see surrounding code context. If no prompt provided, switches to context", "usage": "Enter context mode to see surrounding code context. If no prompt provided, switches to context mode." }, { "keys": "/copy", "desc": "Copy the last assistant message to the clipboard", "usage": "Copy the last assistant message to the clipboard" }, { "keys": "/copy-context", "desc": "Copy the current chat context as markdown, suitable to paste into a web UI", "usage": "Copy the current chat context as markdown, suitable to paste into a web UI" }, { "keys": "/diff", "desc": "Display the diff of changes since the last message", "usage": "Display the diff of changes since the last message" }, { "keys": "/drop", "desc": "Remove files from the chat session to free up context space", "usage": "Remove files from the chat session to free up context space" }, { "keys": "/edit", "desc": "Alias for /editor: Open an editor to write a prompt", "usage": "Alias for /editor: Open an editor to write a prompt" }, { "keys": "/editor", "desc": "Open an editor to write a prompt", "usage": "Open an editor to write a prompt" }, { "keys": "/editor-model", "desc": "Switch the Editor Model to a new LLM", "usage": "Switch the Editor Model to a new LLM" }, { "keys": "/exit", "desc": "Exit the application", "usage": "Exit the application" }, { "keys": "/git", "desc": "Run a git command (output excluded from chat)", "usage": "Run a git command (output excluded from chat)" }, { "keys": "/help", "desc": "Ask questions about aider", "usage": "Ask questions about aider" }, { "keys": "/lint", "desc": "Lint and fix in-chat files or all dirty files if none in chat", "usage": "Lint and fix in-chat files or all dirty files if none in chat" }, { "keys": "/load", "desc": "Load and execute commands from a file", "usage": "Load and execute commands from a file" }, { "keys": "/ls", "desc": "List all known files and indicate which are included in the chat session", "usage": "List all known files and indicate which are included in the chat session" }, { "keys": "/map", "desc": "Print out the current repository map", "usage": "Print out the current repository map" }, { "keys": "/map-refresh", "desc": "Force a refresh of the repository map", "usage": "Force a refresh of the repository map" }, { "keys": "/model", "desc": "Switch the Main Model to a new LLM", "usage": "Switch the Main Model to a new LLM" }, { "keys": "/models", "desc": "Search the list of available models", "usage": "Search the list of available models" }, { "keys": "/multiline-mode", "desc": "Toggle multiline mode (swaps behavior of Enter and Meta+Enter)", "usage": "Toggle multiline mode (swaps behavior of Enter and Meta+Enter)" }, { "keys": "/ok", "desc": "Alias for /code Ok, please go ahead and make those changes. (any args are appended)", "usage": "Alias for /code Ok, please go ahead and make those changes. (any args are appended)" }, { "keys": "/paste", "desc": "Paste image/text from the clipboard into the chat. Optionally provide a name for the image", "usage": "Paste image/text from the clipboard into the chat. Optionally provide a name for the image." }, { "keys": "/quit", "desc": "Exit the application", "usage": "Exit the application" }, { "keys": "/read-only", "desc": "Add files to the chat that are for reference only, or turn added files to read-only", "usage": "Add files to the chat that are for reference only, or turn added files to read-only" }, { "keys": "/reasoning-effort", "desc": "Set the reasoning effort level (values: number or low/medium/high depending on model)", "usage": "Set the reasoning effort level (values: number or low/medium/high depending on model)" }, { "keys": "/report", "desc": "Report a problem by opening a GitHub Issue", "usage": "Report a problem by opening a GitHub Issue" }, { "keys": "/reset", "desc": "Drop all files and clear the chat history", "usage": "Drop all files and clear the chat history" }, { "keys": "/run", "desc": "Run a shell command and optionally add the output to the chat (alias: !)", "usage": "Run a shell command and optionally add the output to the chat (alias: !)" }, { "keys": "/save", "desc": "Save commands to a file that can reconstruct the current chat session's files", "usage": "Save commands to a file that can reconstruct the current chat session's files" }, { "keys": "/settings", "desc": "Print out the current settings", "usage": "Print out the current settings" }, { "keys": "/test", "desc": "Run a shell command and add the output to the chat on non-zero exit code", "usage": "Run a shell command and add the output to the chat on non-zero exit code" }, { "keys": "/think-tokens", "desc": "Set the thinking token budget, eg: 8096, 8k, 10.5k, 0.5M, or 0 to disable", "usage": "Set the thinking token budget, eg: 8096, 8k, 10.5k, 0.5M, or 0 to disable." }, { "keys": "/tokens", "desc": "Report on the number of tokens used by the current chat context", "usage": "Report on the number of tokens used by the current chat context" }, { "keys": "/undo", "desc": "Undo the last git commit if it was done by aider", "usage": "Undo the last git commit if it was done by aider" }, { "keys": "/voice", "desc": "Record and transcribe voice input", "usage": "Record and transcribe voice input" }, { "keys": "/weak-model", "desc": "Switch the Weak Model to a new LLM", "usage": "Switch the Weak Model to a new LLM" }, { "keys": "/web", "desc": "Scrape a webpage, convert to markdown and send in a message", "usage": "Scrape a webpage, convert to markdown and send in a message" } ] } ] }, "midjourney": { "name": "Midjourney", "icon": "fas fa-palette", "source": { "name": "Midjourney Docs — Parameter List", "url": "https://docs.midjourney.com/hc/en-us/articles/32859204029709" }, "categories": [ { "name": "Discord Slash Commands", "shortcuts": [ { "keys": "/imagine", "desc": "Generate image", "usage": "Generate an image from a text prompt." }, { "keys": "/describe", "desc": "Describe image", "usage": "Describe an uploaded image in text." }, { "keys": "/blend", "desc": "Blend images", "usage": "Blend 2-5 images together." }, { "keys": "/settings", "desc": "Settings", "usage": "Configure model version, quality, etc." }, { "keys": "/info", "desc": "Account info", "usage": "Check subscription and usage." }, { "keys": "U1~U4", "desc": "Upscale", "usage": "Upscale the selected image." }, { "keys": "V1~V4", "desc": "Create variation", "usage": "Generate a variation of the selected image." } ] }, { "name": "Prompt Parameters", "shortcuts": [ { "keys": "--ar ", "desc": "Aspect Ratio: change the image shape from the default square", "usage": "Also: --aspect. Example: --ar 2:3. Place after the prompt text." }, { "keys": "--chaos <0-100>", "desc": "Vary the results more between grid images", "usage": "Also: --c. Higher values give more unexpected compositions." }, { "keys": "--oref ", "desc": "Omni Reference: use a person's likeness or an object's form", "usage": "Replaces Character Reference in V7." }, { "keys": "--no ", "desc": "Tell Midjourney what you do not want in the image", "usage": "Example: --no plants removes plants from results." }, { "keys": "--profile", "desc": "Personalization: apply your personalized profile or moodboard style", "usage": "Also: --p." }, { "keys": "--quality ", "desc": "Control detail level and processing time", "usage": "Also: --q." }, { "keys": "--repeat ", "desc": "Generate multiple image sets from a single prompt", "usage": "Also: --r. Subscription tier limits apply." }, { "keys": "--seed ", "desc": "Fix the starting noise for testing and experimenting", "usage": "Same seed and prompt reproduce similar results." }, { "keys": "--stealth", "desc": "Make your creations private on the Midjourney website", "usage": "Availability depends on your plan." }, { "keys": "--public", "desc": "Make your creations public on the Midjourney website", "usage": "Counterpart to --stealth." }, { "keys": "--raw", "desc": "Raw Mode: reduce automatic beautification for more literal results", "usage": "Style-raw switch for the current model." }, { "keys": "--stylize ", "desc": "Control how strongly Midjourney's aesthetic is applied", "usage": "Also: --s. Low values follow the prompt more literally." }, { "keys": "--sref ", "desc": "Style Reference: match the look and feel of another image", "usage": "Combine with --sw to control strength." }, { "keys": "--sw ", "desc": "Style Weight: control the strength of Style References", "usage": "Used together with --sref." }, { "keys": "--sv ", "desc": "Select the style reference algorithm version", "usage": "Used together with --sref." }, { "keys": "--tile", "desc": "Create seamless repeating patterns", "usage": "Output tiles edge-to-edge for textures." }, { "keys": "--version ", "desc": "Switch between Midjourney model versions", "usage": "Also: --v. Example: --v 7." }, { "keys": "--niji", "desc": "Use the model focused on anime and Eastern aesthetics", "usage": "Niji model family switch." }, { "keys": "--draft", "desc": "Generate draft images in V7 at half the GPU cost", "usage": "Faster, lower-cost exploration." }, { "keys": "--weird ", "desc": "Make images quirky and unconventional", "usage": "Also: --w." }, { "keys": "--iw ", "desc": "Image Weight: control the impact of image prompts", "usage": "Higher values follow the linked image more closely." }, { "keys": "--fast", "desc": "Switch GPU speed to Fast Mode for this job", "usage": "Consumes fast GPU time." }, { "keys": "--relax", "desc": "Switch GPU speed to Relax Mode for this job", "usage": "No fast-hour cost; queued generation." }, { "keys": "--turbo", "desc": "Switch GPU speed to Turbo Mode for this job", "usage": "Fastest option; higher GPU cost." }, { "keys": "--hd", "desc": "Generate V8.1 images at higher resolution (2048px)", "usage": "Counterpart: --sd for standard 1024px." }, { "keys": "--sd", "desc": "Generate V8.1 images at standard resolution (1024px)", "usage": "Counterpart: --hd for 2048px." }, { "keys": "--video", "desc": "Generate videos in Discord", "usage": "Video generation switch for Discord workflows." }, { "keys": "--motion low", "desc": "Low motion setting for video generations", "usage": "Counterpart: --motion high." }, { "keys": "--motion high", "desc": "High motion setting for video generations", "usage": "More movement between video frames." }, { "keys": "--loop", "desc": "Create looping video generations", "usage": "Combine with --end to set a custom end frame." }, { "keys": "--bs ", "desc": "Batch Size: number of videos generated per video prompt", "usage": "Controls video batch output count." } ] } ] }, "stable_diffusion": { "name": "Stable Diffusion (A1111)", "icon": "fas fa-image", "source": { "name": "AUTOMATIC1111 WebUI Wiki — Features", "url": "https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Features" }, "categories": [ { "name": "Prompt Syntax & Weights", "shortcuts": [ { "keys": "(word)", "desc": "Increase attention to word by a factor of 1.1", "usage": "Wrap any prompt token in parentheses." }, { "keys": "((word))", "desc": "Increase attention by 1.21 (1.1 x 1.1)", "usage": "Stack parentheses to multiply the effect." }, { "keys": "[word]", "desc": "Decrease attention to word by a factor of 1.1", "usage": "Square brackets reduce emphasis; no numeric weight allowed." }, { "keys": "(word:1.5)", "desc": "Set an explicit attention weight on word", "usage": "Weights work with () only. Default weight is 1.1." }, { "keys": "(word:0.25)", "desc": "Decrease attention by an explicit factor", "usage": "Values below 1 reduce influence (0.25 = quarter strength)." }, { "keys": "\\(word\\)", "desc": "Use literal parentheses characters in the prompt", "usage": "Escape with backslashes: anime_\\(character\\)." }, { "keys": "BREAK", "desc": "Fill the current 75-token chunk with padding and start a new chunk", "usage": "Must be uppercase. Controls how long prompts are split." }, { "keys": "[from:to:when]", "desc": "Prompt editing: swap from one text to another mid-sampling", "usage": "when is a step number or a 0.0-1.0 fraction of steps." }, { "keys": "[to:when]", "desc": "Add text to the prompt after a fixed number of steps", "usage": "Adds the to text once step when is reached." }, { "keys": "[from::when]", "desc": "Remove text from the prompt after a fixed number of steps", "usage": "Drops the from text once step when is reached." }, { "keys": "[cow|horse]", "desc": "Alternating words: swap tokens every other sampling step", "usage": "Step 1 uses cow, step 2 horse, and so on." }, { "keys": "prompt1 AND prompt2", "desc": "Composable diffusion: combine multiple prompts", "usage": "AND must be uppercase. Supports weights: a cat :1.2 AND a dog." }, { "keys": "", "desc": "Apply a LoRA at the given strength", "usage": "Filename without extension; multiplier usually 0-1. Not allowed in the negative prompt." }, { "keys": "", "desc": "Apply a Hypernetwork at the given strength", "usage": "Same syntax family as LoRA extra networks." }, { "keys": "embedding-filename", "desc": "Trigger a Textual Inversion embedding by its filename", "usage": "Place the embedding's filename anywhere in the prompt." } ] }, { "name": "Script & Job Syntax", "shortcuts": [ { "keys": "a|b|c", "desc": "Prompt matrix: generate one image for every combination of the parts", "usage": "Separate alternatives with the pipe character; the first part is always kept. Script -> Prompt matrix." }, { "keys": "{prompt}", "desc": "Style placeholder: substitute the current prompt into the saved style at that position", "usage": "Without it, a style is appended to the prompt instead of wrapping it. Saved in styles.csv." }, { "keys": "--prompt \"text\"", "desc": "Prompts-from-file job field: the positive prompt for one queued job", "usage": "One job per line in the Prompts from file or textbox script." }, { "keys": "--negative_prompt \"text\"", "desc": "Prompts-from-file job field: things the model should avoid", "usage": "Used as unconditional conditioning instead of an empty string." }, { "keys": "--steps N", "desc": "Prompts-from-file job field: sampling steps for that job", "usage": "Overrides the UI value for the single queued job." }, { "keys": "--cfg_scale N", "desc": "Prompts-from-file job field: classifier-free guidance scale", "usage": "Higher values follow the prompt more strictly." }, { "keys": "--sampler_name \"name\"", "desc": "Prompts-from-file job field: sampling method", "usage": "Example: DPM++ 2M Karras, DDIM." }, { "keys": "--seed N", "desc": "Prompts-from-file job field: fixed starting noise", "usage": "Reuse a seed to reproduce a composition." }, { "keys": "--subseed N", "desc": "Prompts-from-file job field: variation seed", "usage": "Paired with subseed_strength to blend between two seeds." }, { "keys": "--subseed_strength N", "desc": "Prompts-from-file job field: how far to move toward the variation seed", "usage": "At maximum you get the subseed image, at minimum the original seed." }, { "keys": "--width N", "desc": "Prompts-from-file job field: output width", "usage": "Set per job in the queued list." }, { "keys": "--height N", "desc": "Prompts-from-file job field: output height", "usage": "Set per job in the queued list." }, { "keys": "--batch_size N", "desc": "Prompts-from-file job field: images generated in parallel per batch", "usage": "Limited by available VRAM." }, { "keys": "--n_iter N", "desc": "Prompts-from-file job field: number of batches to run", "usage": "Total images equal batch_size multiplied by n_iter." }, { "keys": "--styles \"name\"", "desc": "Prompts-from-file job field: apply a saved style to the job", "usage": "Styles come from styles.csv." }, { "keys": "--seed_resize_from_w N", "desc": "Prompts-from-file job field: original width for seed resizing", "usage": "Keeps a known seed looking similar at a different resolution." }, { "keys": "--seed_resize_from_h N", "desc": "Prompts-from-file job field: original height for seed resizing", "usage": "Paired with seed_resize_from_w; ancestral samplers hold this less well." } ] }, { "name": "X/Y/Z Plot & Prompt S/R Syntax", "shortcuts": [ { "keys": "1-5", "desc": "X/Y/Z plot value range: expands to every integer in the range", "usage": "Entered in the X, Y, or Z values field." }, { "keys": "1-5 (+2)", "desc": "X/Y/Z plot range with an increment in parentheses", "usage": "Expands to 1, 3, 5. Negative increments count down: 10-5 (-3)." }, { "keys": "1-10 [5]", "desc": "X/Y/Z plot range with a count in square brackets", "usage": "Expands to that many evenly spaced values: 1, 3, 5, 7, 10." }, { "keys": "darkness,\"light, green\",heat", "desc": "Prompt S/R list where a value itself contains a comma", "usage": "Quote the value with no space after the preceding comma, or it is split into separate items." } ] } ] }, "suno": { "name": "Suno AI", "icon": "fas fa-music", "source": { "name": "Suno Help Center", "url": "https://help.suno.com/" }, "categories": [ { "name": "Prompt Metatags", "shortcuts": [ { "keys": "[Verse]", "desc": "Verse section", "usage": "Specify a verse section in the song." }, { "keys": "[Chorus]", "desc": "Chorus section", "usage": "Specify a chorus section." }, { "keys": "[Bridge]", "desc": "Bridge section", "usage": "Specify a bridge section." }, { "keys": "[Outro]", "desc": "Outro", "usage": "Specify the outro section." }, { "keys": "Genre tags", "desc": "Set genre", "usage": "Tag genres like pop, rock, jazz, hip-hop." }, { "keys": "BPM", "desc": "Set tempo", "usage": "Specify the song BPM (tempo)." } ] } ] }, "lm_studio": { "name": "LM Studio", "icon": "fas fa-desktop", "source": { "name": "LM Studio Docs", "url": "https://lmstudio.ai/docs" }, "categories": [ { "name": "Model Parameters", "shortcuts": [ { "keys": "Temperature", "desc": "Creativity (0-1)", "usage": "Higher = more creative, lower = more deterministic." }, { "keys": "Context Length", "desc": "Token window", "usage": "Max tokens for input + output combined." }, { "keys": "Top P", "desc": "Nucleus sampling", "usage": "Probability mass threshold for token selection." }, { "keys": "Repeat Penalty", "desc": "Avoid repetition", "usage": "Penalise recently used tokens to reduce repetition." }, { "keys": "GPU Layers", "desc": "GPU offload", "usage": "Number of model layers to offload to GPU." } ] }, { "name": "OpenAI-Compatible Endpoints", "shortcuts": [ { "keys": "/v1/chat/completions", "desc": "OpenAI-compatible chat endpoint served by LM Studio", "usage": "POST against the local server started with lms server start." }, { "keys": "/v1/completions", "desc": "OpenAI-compatible text completion endpoint", "usage": "POST; legacy completion style rather than chat messages." }, { "keys": "/v1/embeddings", "desc": "OpenAI-compatible embeddings endpoint", "usage": "POST; returns vectors for the loaded embedding model." }, { "keys": "/v1/responses", "desc": "OpenAI-compatible responses endpoint", "usage": "POST; newer response-style API surface." }, { "keys": "/v1/models", "desc": "List models currently available to the local server", "usage": "GET; mirrors the OpenAI models listing shape." } ] }, { "name": "Inference Config Parameters", "shortcuts": [ { "keys": "temperature", "desc": "Inference parameter: sampling randomness", "usage": "Set per request in the config object, e.g. { \"temperature\": 0.6 }." }, { "keys": "maxTokens", "desc": "Inference parameter: maximum tokens to generate", "usage": "Set per request alongside temperature in the prediction config." }, { "keys": "topP", "desc": "Inference parameter: nucleus sampling cutoff", "usage": "Set per request in the prediction config." }, { "keys": "structured", "desc": "Inference parameter that enforces a schema on the output", "usage": "Pass a schema so the model must emit conforming JSON." } ] }, { "name": "lms CLI Commands", "shortcuts": [ { "keys": "lms server start", "desc": "Start the local LM Studio server", "usage": "Serves the OpenAI-compatible endpoints listed above." }, { "keys": "lms server stop", "desc": "Stop the local server", "usage": "Ends serving without quitting the app." }, { "keys": "lms server status", "desc": "Show whether the local server is running", "usage": "Quick check before sending API requests." }, { "keys": "lms ls", "desc": "List models available locally", "usage": "Shows what can be loaded without downloading." }, { "keys": "lms ps", "desc": "List models currently loaded into memory", "usage": "Use before unloading to see what is resident." }, { "keys": "lms load", "desc": "Load a model into memory", "usage": "Takes the model key; load parameters are set at load time." }, { "keys": "lms unload", "desc": "Unload a model from memory", "usage": "Frees VRAM or RAM held by a loaded model." }, { "keys": "lms get", "desc": "Download a model to the local models directory", "usage": "Fetches by model identifier." }, { "keys": "lms import", "desc": "Import an existing local model file into LM Studio", "usage": "Registers a GGUF or similar file already on disk." }, { "keys": "lms log stream", "desc": "Stream server and prediction logs", "usage": "Useful for debugging prompts and tool calls live." } ] } ] }, "deepseek": { "name": "DeepSeek", "icon": "fas fa-brain", "source": { "name": "DeepSeek API Docs", "url": "https://api-docs.deepseek.com/api/create-chat-completion" }, "categories": [ { "name": "Chat API Parameters", "shortcuts": [ { "keys": "model", "desc": "The model used for the chat completion", "usage": "This fingerprint represents the backend configuration that the model runs with." }, { "keys": "messages", "desc": "A list of messages comprising the conversation so far", "usage": "JSON body field of POST /chat/completions." }, { "keys": "temperature", "desc": "What sampling temperature to use, between 0 and 2", "usage": "Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." }, { "keys": "top_p", "desc": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the...", "usage": "So 0.1 means only the tokens comprising the top 10% probability mass are consid" }, { "keys": "max_tokens", "desc": "The maximum number of tokens that can be generated in the chat completion", "usage": "The total length of input tokens and generated tokens is limited by the model's context length." }, { "keys": "frequency_penalty", "desc": "This parameter is no longer supported", "usage": "It will not take effect if you pass it to the API." }, { "keys": "presence_penalty", "desc": "This parameter is no longer supported", "usage": "It will not take effect if you pass it to the API." }, { "keys": "stop", "desc": "Up to 16 sequences where the API will stop generating further tokens", "usage": "JSON body field of POST /chat/completions." }, { "keys": "stream", "desc": "If set, partial message deltas will be sent", "usage": "Tokens will be sent as data-only server-sent events (SSE) as they become available, with the stream terminated by a" }, { "keys": "stream_options", "desc": "Options for streaming response", "usage": "Only set this when you set If set, an additional chunk will be streamed before the field on this chunk shows the token usage statistics for the..." }, { "keys": "response_format", "desc": "An object specifying the format that the model must output", "usage": "Setting to { \"type\": \"json_object\" } enables JSON Output, which guarantees the message the model generates is valid JSON." }, { "keys": "tools", "desc": "A list of tools the model may call", "usage": "Currently, only functions are supported as a tool." }, { "keys": "tool_choice", "desc": "Controls which (if any) tool is called by the model", "usage": "means the model will not call any tool and instead generates a message." }, { "keys": "logprobs", "desc": "Whether to return log probabilities of the output tokens or not", "usage": "If true, returns the log probabilities of each output token returned in the" }, { "keys": "top_logprobs", "desc": "An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with...", "usage": "JSON body field of POST /chat/completions." }, { "keys": "thinking", "desc": "Controls the switch between thinking and non-thinking mode", "usage": "JSON body field of POST /chat/completions." } ] }, { "name": "Models & Beta Feature Tokens", "shortcuts": [ { "keys": "deepseek-chat", "desc": "Model ID for the general chat model", "usage": "Set as the model field value." }, { "keys": "deepseek-reasoner", "desc": "Model ID for the reasoning model; responses include reasoning_content", "usage": "Set as the model field value. Chain-of-thought is returned in reasoning_content." }, { "keys": "https://api.deepseek.com/beta", "desc": "Base URL that enables beta features", "usage": "Required for chat prefix completion and FIM completion." }, { "keys": "prefix", "desc": "Chat prefix completion: force the assistant reply to continue from a given prefix (beta)", "usage": "Set prefix: true on the last assistant message, with the beta base URL." }, { "keys": "suffix", "desc": "FIM completion: text after the insertion point (beta)", "usage": "Fill-in-the-middle on POST /beta/completions, together with prompt." }, { "keys": "{\"type\": \"json_object\"}", "desc": "response_format value that switches on JSON mode", "usage": "Also instruct the model to produce JSON in the prompt, or output may be empty." } ] } ] }, "glm": { "name": "GLM (Z.ai)", "icon": "fas fa-microchip", "source": { "name": "Z.AI API Reference", "url": "https://docs.z.ai/api-reference/llm/chat-completion" }, "categories": [ { "name": "Chat API Parameters", "shortcuts": [ { "keys": "model", "desc": "The model code to be called", "usage": "GLM-5.3, GLM-5.2, GLM-5.1, GLM-5-Turbo are the latest flagship model series, foundational models specifically designed for agent applications." }, { "keys": "messages", "desc": "The current conversation message list as the model’s prompt input, provided in JSON array format, e.g.,`{“role”:...", "usage": "Possible message types include system messages, user messages, assistant mess" }, { "keys": "do_sample", "desc": "When do_sample is true, sampling strategy is enabled; when do_sample is false, sampling strategy parameters such as...", "usage": "Default value is `true`." }, { "keys": "stream", "desc": "This parameter should be set to false or omitted when using synchronous call", "usage": "It indicates that the model returns all content at once after generating all content." }, { "keys": "reasoning_effort", "desc": "Controls the model's reasoning effort level, takes effect when `thinking` is enabled", "usage": "Default is `max`, supported by `GLM-5.2` and above." }, { "keys": "temperature", "desc": "Sampling temperature, controls the randomness of the output, must be a positive number within the range: `[0.0, 1.0]`", "usage": "The GLM-5.3, GLM-5.2, GLM-5.1, GLM-5, GLM-4.7, GLM-4.6 series default value is `1.0`, GLM-4.5 series" }, { "keys": "top_p", "desc": "Another method of temperature sampling, value range is: `[0.01, 1.0]`", "usage": "The GLM-5.3, GLM-5.2, GLM-5.1, GLM-5, GLM-4.7, GLM-4.6, GLM-4.5 series default value is `0.95`, GLM-4-32B-0414-128K default value is `0.9`." }, { "keys": "max_tokens", "desc": "The maximum number of tokens for model output, the GLM-5.3, GLM-5.2, GLM-5.1, GLM-5, GLM-4.7, GLM-4.6 series...", "usage": "JSON body field (integer) of POST /paas/v4/chat/completions." }, { "keys": "tool_stream", "desc": "Whether to enable streaming response for Function Calls", "usage": "Default value is false." }, { "keys": "tools", "desc": "A list of tools the model may call", "usage": "Currently, only functions are supported as a tool." }, { "keys": "tool_choice", "desc": "Controls how the model selects a tool", "usage": "JSON body field (field) of POST /paas/v4/chat/completions." }, { "keys": "stop", "desc": "Stop word list", "usage": "Generation stops when the model encounters any specified string." }, { "keys": "response_format", "desc": "Specifies the response format of the model", "usage": "Defaults to text." }, { "keys": "request_id", "desc": "Passed by the user side, needs to be unique; used to distinguish each request, 6–64 characters", "usage": "If not provided by the user side, the platform will generate one by default." }, { "keys": "user_id", "desc": "Unique ID for the end user, 6–128 characters", "usage": "Avoid using sensitive information." } ] }, { "name": "Image Generation Parameters", "shortcuts": [ { "keys": "model", "desc": "Model code", "usage": "JSON body field of the image generation endpoint." }, { "keys": "prompt", "desc": "The text description of the image to be generated", "usage": "JSON body field of the image generation endpoint." }, { "keys": "quality", "desc": "The quality of the generated image", "usage": "`glm-image` default is `hd`, others model is `standard`." }, { "keys": "size", "desc": "Image size", "usage": "`glm-image` recommended enum values: `1280x1280` (default), `1568x1056`, `1056x1568`, `1472x1088`, `1088x1472`, `1728x960`, `960x1728`." }, { "keys": "user_id", "desc": "Unique ID of the end user, helping the platform intervene in illegal activities, inappropriate content generation,...", "usage": "ID length: 6 to 128 characters." } ] }, { "name": "Model & Mode Tokens", "shortcuts": [ { "keys": "glm-5.3", "desc": "Latest flagship GLM model ID", "usage": "Set as the model field value in chat completions." }, { "keys": "glm-5-turbo", "desc": "Faster, lower-cost GLM model ID", "usage": "Set as the model field value in chat completions." }, { "keys": "reasoning_effort: \"high\"", "desc": "Raise the reasoning effort level when thinking is enabled", "usage": "Values control how much reasoning the model performs before answering." } ] } ] }, "kimi": { "name": "Kimi (Moonshot AI)", "icon": "fas fa-moon", "source": { "name": "Kimi API Platform Docs", "url": "https://platform.kimi.ai/docs/api/chat" }, "categories": [ { "name": "Chat API Parameters", "shortcuts": [ { "keys": "model", "desc": "Model ID to call; kimi-k3 is the default", "usage": "Set to a model ID from the Models & Modes table below." }, { "keys": "messages", "desc": "The conversation message list; supports dynamic tool messages", "usage": "A {\"role\": \"system\", \"tools\": [...]} message can be inserted at any position." }, { "keys": "max_completion_tokens", "desc": "Maximum tokens to generate", "usage": "Kimi K3 defaults to 131072 and can be set up to 1048576. Replaces the deprecated max_tokens." }, { "keys": "max_tokens", "desc": "Deprecated token limit field", "usage": "Use max_completion_tokens instead." }, { "keys": "response_format", "desc": "Controls the output format; {\"type\": \"json_object\"} enables JSON mode", "usage": "Default is {\"type\": \"text\"}. In JSON mode you must also guide the model to output JSON in the prompt." }, { "keys": "stop", "desc": "Stop words that halt generation on a full match", "usage": "Up to 5 strings, each at most 32 bytes; matched words are not output." }, { "keys": "stream", "desc": "Return the response as a stream", "usage": "Boolean, default false." }, { "keys": "stream_options", "desc": "Options for streaming responses", "usage": "Object with child attributes for stream behavior." }, { "keys": "tools", "desc": "A list of tools the model may call", "usage": "Standard function-tool definitions." }, { "keys": "tool_choice", "desc": "Controls whether and how the model calls tools", "usage": "auto (default), none, required, or an object forcing a specific function." }, { "keys": "logprobs", "desc": "Return log probabilities of the output tokens", "usage": "Boolean, default false; values arrive in the logprobs field of the response." }, { "keys": "top_logprobs", "desc": "Number of most likely tokens to return per position", "usage": "Integer 0-20; requires logprobs: true." }, { "keys": "prediction", "desc": "Predicted Output configuration to speed up largely-known responses", "usage": "Useful when regenerating a file with only minor changes." }, { "keys": "prompt_cache_key", "desc": "Cache key to raise cache hit rates across similar requests", "usage": "For coding agents, typically a session or task ID; reuse it when a session resumes." }, { "keys": "safety_identifier", "desc": "Stable per-user identifier for abuse detection", "usage": "Hash the username or email rather than sending it raw." }, { "keys": "reasoning_effort", "desc": "Reasoning effort level for Kimi K3 thinking", "usage": "Values: low, high, max (default max). K3 always thinks with Preserved Thinking." } ] }, { "name": "Models & Mode Tokens", "shortcuts": [ { "keys": "kimi-k3", "desc": "Flagship model ID with always-on thinking", "usage": "Default model; set as the model field value." }, { "keys": "kimi-k2.7-code", "desc": "Coding-focused model ID", "usage": "Set as the model field value." }, { "keys": "kimi-k2.7-code-highspeed", "desc": "Faster variant of the coding model", "usage": "Set as the model field value." }, { "keys": "kimi-k2.6", "desc": "Previous-generation general model ID", "usage": "Set as the model field value." }, { "keys": "kimi-k2.5", "desc": "Older general model ID", "usage": "Set as the model field value." }, { "keys": "partial: true", "desc": "Partial Mode: force the reply to continue from a given prefix", "usage": "Append a message with role: assistant, partial: true, and the prefix text in content at the end of messages." } ] } ] }, "kling": { "name": "Kling AI", "icon": "fas fa-film", "source": { "name": "Kling AI API Documentation", "url": "https://kling.ai/document-api/api/video/3-0-omni/image-to-video" }, "categories": [ { "name": "Generation Input Parameters", "shortcuts": [ { "keys": "contents", "desc": "Reference input collection: prompts, images, Elements", "usage": "Array of typed inputs forming the generation request." }, { "keys": "\"type\": \"prompt\"", "desc": "Prompt input identifier inside contents", "usage": "Carries the text field with positive and negative descriptions." }, { "keys": "\"type\": \"first_frame\"", "desc": "First-frame image input identifier", "usage": "Anchors the opening frame of the generated video." }, { "keys": "\"type\": \"last_frame\"", "desc": "Last-frame image input identifier", "usage": "Anchors the closing frame of the generated video." }, { "keys": "\"type\": \"element\"", "desc": "Element input identifier", "usage": "References a reusable Element in the generation." }, { "keys": "\"type\": \"image\"", "desc": "Appearance reference image (Motion Control)", "usage": "Generated characters follow the reference image; proportions should match the motion video." }, { "keys": "\"type\": \"video\"", "desc": "Motion reference video identifier (Motion Control)", "usage": "Drives character motion from a reference clip." }, { "keys": "text", "desc": "Prompt text content, positive and negative descriptions", "usage": "String field inside a prompt-type content item; can add elements and motion effects." } ] }, { "name": "Output Settings Parameters", "shortcuts": [ { "keys": "settings", "desc": "Output configuration object: resolution, duration, and related fields", "usage": "Container for generation output parameters." }, { "keys": "multi_shot", "desc": "Whether to generate multi-shot video", "usage": "Boolean; when false, multi-shot prompts will not produce multi-shot output." }, { "keys": "audio", "desc": "Audio generation switch for the video", "usage": "Values: native (audio matching the visuals) or off (silent)." }, { "keys": "resolution", "desc": "Resolution of the generated video", "usage": "Set inside the settings object." } ] }, { "name": "Task & Query Parameters", "shortcuts": [ { "keys": "options", "desc": "General configuration: callback address, watermark, and similar", "usage": "Container object alongside contents and settings." }, { "keys": "callback_url", "desc": "Callback URL for task result notifications", "usage": "Server sends a notification on task status change; see the Callback Protocol." }, { "keys": "external_task_id", "desc": "Custom task ID, unique within the account", "usage": "Does not overwrite the system task ID; usable for status queries." }, { "keys": "watermark_info", "desc": "Whether to also generate a watermarked result", "usage": "Object with an enabled boolean." }, { "keys": "task_ids", "desc": "System task IDs to query, as a request path parameter", "usage": "Choose either task_ids or external_task_ids per query, not both." }, { "keys": "external_task_ids", "desc": "Custom task IDs to query, as a request path parameter", "usage": "Alternative to task_ids for status queries." }, { "keys": "start_time", "desc": "Start of the task-creation filter window", "usage": "Unix timestamp in milliseconds; defaults to end_time minus 30 days." }, { "keys": "end_time", "desc": "End of the task-creation filter window", "usage": "Unix timestamp in milliseconds; defaults to now." }, { "keys": "cursor", "desc": "Continuation cursor for paged task queries", "usage": "Use next_cursor from the previous query; when set, start_time and end_time are ignored." }, { "keys": "filters", "desc": "Task query filter criteria", "usage": "Key/value entries; key status or product_type." }, { "keys": "\"key\": \"status\"", "desc": "Filter tasks by status", "usage": "Values: submitted, processing, succeeded, failed." }, { "keys": "\"key\": \"product_type\"", "desc": "Filter tasks by function type", "usage": "Values: video, image, try_on." } ] } ] }, "vidu": { "name": "Vidu", "icon": "fas fa-video", "source": { "name": "Vidu Platform API Docs", "url": "https://platform.vidu.com/docs/text-to-video" }, "categories": [ { "name": "Generation Parameters", "shortcuts": [ { "keys": "model", "desc": "Model name", "usage": "Accepted values:viduq3-turbo, viduq3-pro , viduq2 , viduq1 -viduq3-turbo: Compared to viduq3-pro, the generation speed is faster -viduq3-pro: Supports audio-visual synchronization,... Required." }, { "keys": "style", "desc": "The style of output video", "usage": "Defaults to general, Accepted values: general anime - general : General style. Allows style control through prompts - anime: Anime style. Optimized for anime aesthetics, with better..." }, { "keys": "prompt", "desc": "Text prompt A textual description for video generation, with a maximum length of 5000 characters", "usage": "Required." }, { "keys": "duration", "desc": "Video duration", "usage": "Default values vary by model: - viduq3-pro,viduq3-turbo: default 5s, available: 1 - 16 - viduq2: default 5s, available: 1 - 10 - viduq1: default 5s, available: 5" }, { "keys": "seed", "desc": "Random seed -", "usage": "Defaults to a random seed number - Manually set values will override the default random seed" }, { "keys": "aspect_ratio", "desc": "The aspect ratio of the output video", "usage": "Defaults to 16:9, accepted: 16:9 9:163:4 4:3 1:1 Note:3:4& 4:3only support q2 & q3 model" }, { "keys": "resolution", "desc": "Resolution", "usage": "Default values vary by model & duration: - viduq3-pro , viduq3-turbo (1-16s): default 720p, available: 540p, 720p, 1080p - viduq2 (1-10s): default 720p, available: 540p 720p 1080p -..." }, { "keys": "movement_amplitude", "desc": "The movement amplitude of objects in the frame", "usage": "Defaults to auto, accepted value: auto small medium large This parameter does not take effect when using the q2 & q3 model" }, { "keys": "images", "desc": "An image to be used as the start frame of the generated video For fields that accept images: - Only accepts 1 image -...", "usage": "- Supported formats: png, jpeg, jpg, webp - The aspect ratio of the images must be less than 1:4 or 4:1 - All images are limited to 50MB - The post body of the HTTP request should not... Required." }, { "keys": "voice_id", "desc": "Voice ID, The Q3 series model is not effective Used to determine the voice character in the video", "usage": "The system will automatically recommend a suitable voice, and optional values can be found in the Voice List. You can also use the Voice Cloning API to clone any voice. The voice_id..." }, { "keys": "is_rec", "desc": "Whether to use the recommended prompt", "usage": "- true: Yes, the system will automatically generate and apply a recommended prompt to create the video. The number of recommended prompts = 1. - false: No, the video will be generated..." }, { "keys": "auto_subjects", "desc": "Optional | Whether to use the intelligent entity library capability, default is false, optional values are true and false...", "usage": "- false: Do not use the intelligent agent library capability." }, { "keys": "subjects", "desc": "Required | When using the q3, q2, q1, and 2.0 models, only the main body of the image and text can be used - The maximum...", "usage": "JSON body field of the Vidu generation endpoints." }, { "keys": "videos", "desc": "Optional | The video URL corresponding to the subject", "usage": "All subjects share a 13s duration (each image subject = 1s). Must provide either this or images. - Note 1: This parameter is only supported by the viduq2-pro model. - Note 2: When using..." } ] }, { "name": "Task & Delivery Parameters", "shortcuts": [ { "keys": "bgm", "desc": "Whether to add background music to the generated video.（q3 model not available） Default: false", "usage": "Acceptable values: true, false. When true, the system will automatically add a suitable BGM. BGM has no time limit and the system automatically adapts. BGM does not take effect when the..." }, { "keys": "audio", "desc": "Whether to use direct audio-video generation capability", "usage": "Default: true. Enumerated values: - false: No direct audio-video generation, outputs silent video - true: Requires audio-video synchronization, outputs video with sound (including..." }, { "keys": "payload", "desc": "transparent transmission parameters No processing, only data transmission，with a maximum length of 1048576 characters", "usage": "JSON body field of the Vidu generation endpoints." }, { "keys": "off_peak", "desc": "off peak mode,", "usage": "Defaults to false, accepted value: true false - true：off peak generate mode； - false：normal generate mode； - The off_peak mode consumes lower points, please refer to the details Pricing...." }, { "keys": "callback_url", "desc": "Callback When creating a task, you need to actively set the callback_url with a POST request", "usage": "When the video generation task changes its status, Vidu will send a callback request to this URL, containing the latest status of the task. The structure of the callback request content..." }, { "keys": "audio_type", "desc": "Audio type, required when audio is true, defaults to all -All: Sound effects+vocals -Speech_only: Vocal only...", "usage": "JSON body field of the Vidu generation endpoints." } ] }, { "name": "Model IDs", "shortcuts": [ { "keys": "viduq3-pro", "desc": "Model ID with audio-visual synchronization and video shot segmentation", "usage": "Set as the model field value." }, { "keys": "viduq3-turbo", "desc": "Faster variant of viduq3-pro", "usage": "Set as the model field value." }, { "keys": "viduq2", "desc": "Second-generation Vidu model ID", "usage": "Supports 3:4 and 4:3 aspect ratios; duration 1-10s." }, { "keys": "viduq1", "desc": "First-generation model: clear image, smooth transition, stable camera", "usage": "Fixed 5s duration at 1080p." } ] } ] }, "minimax": { "name": "MiniMax (Hailuo)", "icon": "fas fa-wave-square", "source": { "name": "MiniMax Platform API Reference", "url": "https://platform.minimax.io/docs/api-reference/video-generation-v2-create" }, "categories": [ { "name": "Video Generation Parameters", "shortcuts": [ { "keys": "model", "desc": "Model name", "usage": "Currently available: MiniMax-H3." }, { "keys": "content", "desc": "Array of multimodal input describing the information used to generate the video", "usage": "Each element is distinguished by type (text / image_url / video_url / audio_url) and can be labeled with a role. Every request must include one non-empty text item (the prompt is..." }, { "keys": "resolution", "desc": "Video resolution", "usage": "Currently available: 768P, 2K." }, { "keys": "duration", "desc": "Duration of the generated video in seconds", "usage": "Required, integer. Available values: 4-15." }, { "keys": "ratio", "desc": "Aspect ratio of the generated video", "usage": "Defaults to adaptive (the most suitable ratio is chosen automatically based on the input; the actual ratio can be read from the ratio field of the query endpoint). Available values:..." }, { "keys": "callback_url", "desc": "Callback URL for task status changes", "usage": "Once configured, the MiniMax server first sends a verification request containing a challenge field (you must return the challenge unchanged within 3 seconds to complete verification);..." } ] }, { "name": "Multimodal Content & Model Tokens", "shortcuts": [ { "keys": "\"type\": \"text\"", "desc": "Text prompt content item; every scenario must include one", "usage": "Inside the content array, with the prompt in the text field." }, { "keys": "\"type\": \"image_url\"", "desc": "Image input content item", "usage": "Supplies a reference or first-frame image to the generation." }, { "keys": "\"type\": \"video_url\"", "desc": "Video input content item", "usage": "Supplies a reference video to the generation." }, { "keys": "\"type\": \"audio_url\"", "desc": "Audio input content item", "usage": "Supplies reference audio to the generation." }, { "keys": "role", "desc": "Position or purpose of a content item", "usage": "Conditionally required depending on the content type." }, { "keys": "MiniMax-H3", "desc": "Current video generation model ID (Hailuo 03)", "usage": "Set as the model field value." } ] }, { "name": "Chat API Parameters", "shortcuts": [ { "keys": "model", "desc": "Model ID", "usage": "JSON body field of the OpenAI-compatible chat endpoint." }, { "keys": "service_tier", "desc": "Service tier for request admission", "usage": "Supported values are standard and priority. If omitted, the request uses the standard tier. The priority price is 1.5 times the standard price and ensures priority admission so the..." }, { "keys": "messages", "desc": "A list of messages containing the conversation history", "usage": "Supports text, image, video, and tool call content." }, { "keys": "thinking", "desc": "Controls MiniMax-M3 thinking", "usage": "When omitted, adaptive thinking is enabled by default and responses include thinking content. For M2.x models, thinking cannot be disabled." }, { "keys": "reasoning_split", "desc": "Output-format switch", "usage": "When enabled, separates thinking content into the reasoning_content and reasoning_details fields. This does not enable or disable thinking." }, { "keys": "stream", "desc": "Whether to use streaming output, defaults to false", "usage": "When set to true, the response will be returned in chunks." }, { "keys": "stream_options", "desc": "Streaming response options", "usage": "JSON body field of the OpenAI-compatible chat endpoint." }, { "keys": "max_completion_tokens", "desc": "Specifies the upper limit for generated content length, in tokens", "usage": "For MiniMax-M3 the recommended value is 131072 (128K) and the maximum is 524288 (512K); for other models the recommended value is 65536 (64K) and the maximum is 204800 (200K). If..." }, { "keys": "temperature", "desc": "Temperature coefficient, affects output randomness", "usage": "Range [0, 2], default 1. Higher values produce more random output; lower values produce more deterministic output." }, { "keys": "top_p", "desc": "Nucleus sampling parameter", "usage": "Range [0, 1]. Default is 0.95 for MiniMax-M3 and 0.9 for M2.x models." }, { "keys": "tools", "desc": "Tool definition list", "usage": "Function tools are supported." }, { "keys": "max_tokens", "desc": "Legacy generation length limit parameter", "usage": "Deprecated; use max_completion_tokens instead." } ] } ] }, "pixverse": { "name": "PixVerse", "icon": "fas fa-clapperboard", "source": { "name": "PixVerse Platform API Docs", "url": "https://docs.platform.pixverse.ai/text-to-video-generation-13016634e0" }, "categories": [ { "name": "Generation Parameters", "shortcuts": [ { "keys": "aspect_ratio", "desc": "Aspect ratio", "usage": "other models : 16:9, 4:3, 1:1, 3:4, 9:16 v6/c1 models : 16:9, 4:3, 1:1, 3:4, 9:16, 2:3, 3:2, 21:9" }, { "keys": "duration", "desc": "Video duration", "usage": "v.3.5/v4/v4.5 : 5/8 (v3.5 1080p cannot use 8) v5 : 5/8 v5.5/v5.6 : 5/8/10 (1080p cannot use 10) v6/c1 : 1~15" }, { "keys": "model", "desc": "Model version (now supports", "usage": "v3.5/v4/v4.5/v5/v5.5/v5.6/v6/c1" }, { "keys": "prompt", "desc": "Prompt <= 5000 characters", "usage": "JSON body field of the PixVerse video generation endpoints." }, { "keys": "quality", "desc": "Video quality (\"360p\", \"540p\", \"720p\", \"1080p\")", "usage": "JSON body field of the PixVerse video generation endpoints." }, { "keys": "seed", "desc": "Random seed,", "usage": "range: 0 - 2147483647" }, { "keys": "generate_multi_clip_switch", "desc": "Supported in", "usage": "v5.5/v6 models. Single or multi-clip switch. controls single-clip and multi-clip generation modes. true: Multi-clip , false: Single-clip. default value : false" } ] }, { "name": "Audio & Lip Sync Parameters", "shortcuts": [ { "keys": "generate_audio_switch", "desc": "Supported in", "usage": "v5.5/v5.6/v6/c1 models. Audio switch. Controls whether the video has audio. true: Audio on , false: Audio off . default value : false" }, { "keys": "sound_effect_switch", "desc": "Supported in", "usage": "v5 models and below." }, { "keys": "sound_effect_content", "desc": "Supported in", "usage": "v5 models and below. Activated when sound_effect_switch=true, Describe the sound effect you want. Leave blank for auto generation." }, { "keys": "lip_sync_tts_switch", "desc": "Supported in", "usage": "v5 models and below. Set to true if you want to enable this feature. Default is false." }, { "keys": "lip_sync_tts_content", "desc": "Supported in", "usage": "v5 models and below. ~140 (UTF-8) characters" }, { "keys": "lip_sync_tts_speaker_id", "desc": "Supported in", "usage": "v5 models and below. id from Get speech tts list" } ] }, { "name": "Image & Template Inputs", "shortcuts": [ { "keys": "img_id", "desc": "Image ID from Upload image API", "usage": "single image or single-image templates" }, { "keys": "img_ids", "desc": "img_ids is only for multi-image templates", "usage": "ex) \"img_ids \":[0,0]" }, { "keys": "template_id", "desc": "Template ID (template_id must be activated before use)", "usage": "JSON body field of the PixVerse video generation endpoints." } ] }, { "name": "Endpoints & Required Headers", "shortcuts": [ { "keys": "POST /openapi/v2/video/text/generate", "desc": "Create a text-to-video generation task", "usage": "Requires API-KEY and a unique Ai-trace-id (UUID) header per request." }, { "keys": "POST /openapi/v2/video/img/generate", "desc": "Create an image-to-video generation task", "usage": "Takes img_id from an uploaded image." }, { "keys": "API-KEY", "desc": "Required request header carrying your PixVerse platform key", "usage": "Header, not a body field." }, { "keys": "Ai-trace-id", "desc": "Required request header: a UUID unique to each request", "usage": "Used for tracing; reusing a value across requests is not allowed." } ] }, { "name": "Model IDs", "shortcuts": [ { "keys": "c1", "desc": "Latest PixVerse model generation", "usage": "Set as the model field value." }, { "keys": "v6", "desc": "Sixth-generation model", "usage": "Supports the newer aspect ratio set and audio switch." }, { "keys": "v5.6", "desc": "Model version with audio generation support", "usage": "Set as the model field value." }, { "keys": "v5.5", "desc": "Model version supporting audio and multi-clip switches", "usage": "Set as the model field value." }, { "keys": "v4.5", "desc": "Earlier model version", "usage": "Duration options differ from v6/c1." }, { "keys": "v3.5", "desc": "Oldest listed model version", "usage": "1080p output cannot use the 8 second duration." } ] } ] }, "manus": { "name": "Manus", "icon": "fas fa-hands", "source": { "name": "Manus API Reference (open.manus.ai)", "url": "https://open.manus.ai/docs/v2/task.create" }, "categories": [ { "name": "Task Parameters", "shortcuts": [ { "keys": "project_id", "desc": "Project ID to associate this task with", "usage": "The project's instruction will be automatically applied. Use project.list to get available project IDs." }, { "keys": "locale", "desc": "Locale for the task output language (e.g., \"en\", \"zh-CN\", \"ja\")", "usage": "Defaults to the user's account locale setting." }, { "keys": "interactive_mode", "desc": "When enabled, the agent may pause and ask follow-up questions if the input is insufficient", "usage": "When disabled (default), the agent proceeds with best-effort execution without asking." }, { "keys": "hide_in_task_list", "desc": "When true, the task will not appear in the Manus webapp task list", "usage": "The task is still accessible via the task_url in the response. Useful for automated/background tasks." }, { "keys": "share_visibility", "desc": "Controls who can view the task", "usage": "\"private\" (default) — only the task creator can view. \"team\" — all team members can view. \"public\" — anyone with the share_url can view without authentication." }, { "keys": "agent_profile", "desc": "Agent profile to use for the task", "usage": "\"manus-1.6\" (default) — standard capability. \"manus-1.6-lite\" — lightweight, faster responses. \"manus-1.6-max\" — maximum capability. Free personal accounts are downgraded to..." }, { "keys": "title", "desc": "Custom title for the task", "usage": "If not provided, a title will be auto-generated based on the input message." }, { "keys": "structured_output_schema", "desc": "JSON Schema for structured output extraction", "usage": "When provided, the agent runs normally, then a post-processing step extracts a result conforming to your schema. The schema must follow the Structured Output subset of JSON Schema: all..." } ] }, { "name": "Message Object Fields", "shortcuts": [ { "keys": "message.content", "desc": "String (plain text) or array of ContentPart objects", "usage": "User text is limited to approximately 5,000 estimated tokens per request; the exact character count varies by language and content. For an array, the limit applies to the combined text..." }, { "keys": "message.connectors", "desc": "List of connector IDs to enable for this task", "usage": "Resolution order when omitted: 1) if the task belongs to a project, the project's default connectors are used; 2) otherwise, the user's default enabled connectors are used. Use..." }, { "keys": "message.enable_skills", "desc": "Skill IDs to enable for this task", "usage": "If empty or omitted, loads the skills the user has enabled in their account settings. Use skill.list to retrieve available skill IDs." }, { "keys": "message.force_skills", "desc": "Skill IDs the agent must invoke during this task", "usage": "Forced skills are automatically available even if not listed in enable_skills." }, { "keys": "message.task_references", "desc": "Task IDs of existing tasks to reference from this message", "usage": "The agent can then browse the conversation and files of those tasks on demand. Each entry must be a bare 22-character alphanumeric task ID — a full task URL, or a shortcut value such as..." } ] }, { "name": "Content Part Types & Fields", "shortcuts": [ { "keys": "\"type\": \"text\"", "desc": "Must be \"text\"", "usage": "Field of a ContentPart item inside message.content." }, { "keys": "text", "desc": "The text content of the message", "usage": "Across a ContentPart array, all text parts must contain no more than approximately 5,000 estimated tokens in total." }, { "keys": "\"type\": \"file\"", "desc": "Must be \"file\"", "usage": "Field of a ContentPart item inside message.content." }, { "keys": "file_id", "desc": "ID of a previously uploaded file", "usage": "Upload via file.upload first to get the file ID." }, { "keys": "file_url", "desc": "Publicly accessible URL to the file", "usage": "The agent will download it directly." }, { "keys": "file_data", "desc": "Base64 encoded file content", "usage": "Format: data:;base64, (e.g., data:application/pdf;base64,JVBERi0...)." }, { "keys": "filename", "desc": "Display name of the file including extension (e.g., \"report.pdf\")", "usage": "Required when using file_data; recommended for file_url." }, { "keys": "mime_type", "desc": "MIME type of the file (e.g., \"application/pdf\", \"image/png\")", "usage": "Optional; auto-detected from filename if omitted." }, { "keys": "\"type\": \"voice\"", "desc": "Must be \"voice\"", "usage": "Field of a ContentPart item inside message.content." } ] }, { "name": "Endpoints, Profiles & Follow-up Fields", "shortcuts": [ { "keys": "POST /v2/task.create", "desc": "Create a new task; runs asynchronously", "usage": "Poll task.listMessages for progress. OAuth scope: create_task or manage_all_tasks." }, { "keys": "POST /v2/task.sendMessage", "desc": "Send a follow-up message to an existing task", "usage": "Use this instead of task.create when talking to an agent that already exists." }, { "keys": "manus-1.6", "desc": "Default agent profile: standard capability", "usage": "Set as the agent_profile value on task.create or per turn on task.sendMessage." }, { "keys": "task_id", "desc": "The unique identifier of the task to send the message to", "usage": "Supports the shortcut agent-default-main_task for the IM agent's main task." }, { "keys": "clear_connectors", "desc": "Removes all connectors from this task for this and subsequent turns", "usage": "Combine with message.connectors to form three states: a non-empty message.connectors overrides the task's connectors with the new list; clear_connectors: true clears all connectors;..." } ] } ] }, "qwen": { "name": "Qwen (Alibaba Model Studio)", "icon": "fas fa-cloud", "source": { "name": "Alibaba Cloud Model Studio - OpenAI compatible Chat", "url": "https://www.alibabacloud.com/help/en/model-studio/qwen-api-via-openai-chat-completions" }, "categories": [ { "name": "Chat API Parameters", "shortcuts": [ { "keys": "model", "desc": "Model to call", "usage": "Supported families: Qwen LLM (commercial and open source), Qwen-VL, Qwen-Coder, Qwen-Omni, Qwen-Math, plus DeepSeek, Kimi, GLM and MiniMax. Required." }, { "keys": "messages", "desc": "Conversation context passed to the model, in conversational order", "usage": "Required. System message, if present, must come first." }, { "keys": "temperature", "desc": "Sampling temperature controlling output diversity", "usage": "Value range [0, 2). Set either temperature or top_p, not both." }, { "keys": "top_p", "desc": "Nucleus sampling probability threshold", "usage": "Value range (0, 1.0]. Set either temperature or top_p, not both." }, { "keys": "top_k", "desc": "Number of candidate tokens sampled during generation", "usage": "Larger is more random. null or a value above 100 disables the top_k strategy." }, { "keys": "repetition_penalty", "desc": "Penalty for consecutive repeated sequences", "usage": "1.0 means no penalty; raise it to reduce repetition. No strict upper bound." }, { "keys": "presence_penalty", "desc": "Controls content repetition across the generated text", "usage": "Value range [-2.0, 2.0]. Positive reduces repetition, negative increases it." }, { "keys": "max_completion_tokens", "desc": "Maximum output length, including chain-of-thought and answer", "usage": "Generation stops early with finish_reason length if exceeded." }, { "keys": "enable_thinking", "desc": "Switch thinking mode on for mixed-thinking models", "usage": "Applies to Qwen3 family, Qwen3-Omni-Flash and Qwen3-VL models." }, { "keys": "thinking_budget", "desc": "Maximum tokens allowed for the thinking process", "usage": "Applies to Qwen3 family, GLM and Kimi models; kimi-k3 does not support it." }, { "keys": "reasoning_effort", "desc": "Inference intensity level", "usage": "Valid values vary by model; DeepSeek-V4 and GLM default to high, with max available." }, { "keys": "seed", "desc": "Random seed for reproducible results", "usage": "Same seed and unchanged parameters return the same result as far as possible." }, { "keys": "tools", "desc": "Array of tool objects the model may call in function calling", "usage": "If set and the model decides to call a tool, tool info is returned in the response." }, { "keys": "stream_options", "desc": "Configuration for streaming output", "usage": "Takes effect only when stream is true; include_usage adds token usage to the last chunk." }, { "keys": "audio", "desc": "Voice and format of the output audio", "usage": "Qwen-Omni models only, and requires modalities set to [\"text\",\"audio\"]." }, { "keys": "search_options", "desc": "Web search strategy", "usage": "Not a standard OpenAI parameter; via the Python SDK place it in extra_body." } ] }, { "name": "Output, Tool & Feature Parameters", "shortcuts": [ { "keys": "stream", "desc": "Reply in streaming output mode", "usage": "Default false. When true the model outputs content as it is generated, in data chunks." }, { "keys": "stop", "desc": "Stop words or token IDs that halt generation immediately", "usage": "A string or array; you cannot mix strings and token IDs in one array." }, { "keys": "n", "desc": "Number of responses to generate", "usage": "Default 1, range 1-4. Only supported by Qwen3 models in non-thinking mode." }, { "keys": "max_tokens", "desc": "Maximum output tokens (to be deprecated)", "usage": "Use max_completion_tokens for new integrations; the meaning varies by model." }, { "keys": "response_format", "desc": "Format of the response", "usage": "Default {\"type\": \"text\"}. Use {\"type\": \"json_object\"} for structured JSON output." }, { "keys": "tool_choice", "desc": "Tool selection strategy", "usage": "Default auto. Set it to force a specific tool or to disable all tools." }, { "keys": "parallel_tool_calls", "desc": "Enable parallel tool calling", "usage": "Default false." }, { "keys": "modalities", "desc": "Modality of the output data", "usage": "Default [\"text\"]. Qwen-Omni models only; [\"text\",\"audio\"] adds audio output." }, { "keys": "enable_search", "desc": "Enable web search", "usage": "Default false. If search does not trigger, set forced_search inside search_options." }, { "keys": "logprobs", "desc": "Return log probabilities of the output tokens", "usage": "Default false." }, { "keys": "top_logprobs", "desc": "Number of most likely candidate tokens returned per step", "usage": "Range [0, 5]. Takes effect only when logprobs is true." }, { "keys": "vl_high_resolution_images", "desc": "Raise the input image pixel limit to the 16384-token equivalent", "usage": "Default false. Qwen-VL high-resolution image processing." }, { "keys": "enable_code_interpreter", "desc": "Enable the code interpreter feature", "usage": "Default false." } ] } ] }, "hunyuan": { "name": "Tencent Hunyuan", "icon": "fas fa-atom", "source": { "name": "Tencent Cloud Hunyuan ChatCompletions API", "url": "https://cloud.tencent.com/document/api/1729/105701" }, "categories": [ { "name": "Core Request Parameters", "shortcuts": [ { "keys": "Model", "desc": "Model name to call", "usage": "Required. Example: hunyuan-turbos-latest. Billing differs by model." }, { "keys": "Messages.N", "desc": "Chat context array, ordered oldest to newest", "usage": "Required. Up to 40 entries. Role values: system, user, assistant, tool. System, if present, must be first; user and assistant alternate." }, { "keys": "Stream", "desc": "Streaming response switch", "usage": "Defaults to false. When true, results arrive incrementally over SSE in Choices[n].Delta." }, { "keys": "StreamModeration", "desc": "Content moderation switch for streaming output", "usage": "Boolean." }, { "keys": "Temperature", "desc": "Sampling temperature controlling output randomness", "usage": "Float. Set either Temperature or TopP, not both." }, { "keys": "TopP", "desc": "Nucleus sampling probability threshold", "usage": "Float. Set either Temperature or TopP, not both." }, { "keys": "Seed", "desc": "Random seed for reproducible output", "usage": "Non-zero positive integer up to 10000. Not recommended unless needed; unsuitable values degrade quality." }, { "keys": "Stop.N", "desc": "Custom stop strings that end generation", "usage": "Array of strings." } ] }, { "name": "Tools & Reasoning Parameters", "shortcuts": [ { "keys": "Tools.N", "desc": "List of callable tools for function calling", "usage": "Effective only on hunyuan-turbos, hunyuan-t1 and hunyuan-functioncall models." }, { "keys": "ToolChoice", "desc": "Tool usage mode", "usage": "Values: none, auto, custom. Defaults to auto. Effective on hunyuan-turbo and hunyuan-functioncall models." }, { "keys": "EnableThinking", "desc": "Chain-of-thought reasoning switch", "usage": "Enabled by default. Currently effective only on the hunyuan-a13b model." } ] }, { "name": "Search & Enhancement Switches", "shortcuts": [ { "keys": "EnableEnhancement", "desc": "Capability enhancement switch, such as search", "usage": "Boolean." }, { "keys": "ForceSearchEnhancement", "desc": "Force search enhancement on", "usage": "Boolean." }, { "keys": "EnableSpeedSearch", "desc": "Turn on the fast search variant", "usage": "Defaults to false. When on and search is triggered, streaming returns the first token sooner." }, { "keys": "SearchInfo", "desc": "Return SearchInfo in the response when search is triggered", "usage": "Defaults to false." }, { "keys": "Citation", "desc": "Search citation superscript switch", "usage": "Boolean." }, { "keys": "EnableMultimedia", "desc": "Multimedia output switch", "usage": "Boolean." }, { "keys": "EnableRecommendedQuestions", "desc": "Recommended follow-up questions switch", "usage": "Boolean." }, { "keys": "TopicChoice", "desc": "Topic passed in by the caller", "usage": "String." } ] }, { "name": "Common API Parameters", "shortcuts": [ { "keys": "Action", "desc": "Common parameter; the API action name", "usage": "Fixed value for this endpoint: ChatCompletions. Required." }, { "keys": "Version", "desc": "Common parameter; the API version", "usage": "Fixed value for this endpoint: 2023-09-01. Required." }, { "keys": "Region", "desc": "Common parameter; the region", "usage": "Optional for this endpoint." } ] } ] }, "openclaw": { "name": "OpenClaw", "icon": "fas fa-terminal", "source": { "name": "OpenClaw Docs - Slash commands", "url": "https://docs.openclaw.ai/tools/slash-commands" }, "categories": [ { "name": "Core Slash Commands", "shortcuts": [ { "keys": "/new [model]", "desc": "Archive the current session and start a fresh one", "usage": "Type in any connected chat channel or the Control UI." }, { "keys": "/reset [soft [message]]", "desc": "Reset the current session in place", "usage": "soft keeps the transcript, drops reused CLI backend session ids, and reruns startup" }, { "keys": "/name ", "desc": "Name or rename the current session", "usage": "Omit the title to see the current name and a suggestion" }, { "keys": "/compact [instructions]", "desc": "Compact the session context", "usage": "See Compaction" }, { "keys": "/stop", "desc": "Abort the current run", "usage": "Type in any connected chat channel or the Control UI." }, { "keys": "/session idle <duration|off>", "desc": "Manage thread-binding idle expiry", "usage": "Type in any connected chat channel or the Control UI." }, { "keys": "/session max-age <duration|off>", "desc": "Manage thread-binding max-age expiry", "usage": "Type in any connected chat channel or the Control UI." }, { "keys": "/export-session [path]", "desc": "Owner-only", "usage": "Export the current session to HTML inside the workspace. Alias: /export" }, { "keys": "/export-trajectory [path]", "desc": "Export a JSONL trajectory bundle for the current session", "usage": "Alias: /trajectory" }, { "keys": "/think <level|default>", "desc": "Set the thinking level or clear the session override", "usage": "Aliases: /thinking, /t" }, { "keys": "/verbose on|off|full", "desc": "Toggle verbose output", "usage": "Alias: /v" }, { "keys": "/trace on|off", "desc": "Toggle plugin trace output for the current session", "usage": "Type in any connected chat channel or the Control UI." }, { "keys": "/fast [status|auto|on|off|default]", "desc": "Show, set, or clear fast mode", "usage": "Type in any connected chat channel or the Control UI." }, { "keys": "/reasoning [on|off|stream]", "desc": "Toggle reasoning visibility", "usage": "Alias: /reason" }, { "keys": "/elevated [on|off|ask|full]", "desc": "Toggle elevated mode", "usage": "Alias: /elev" }, { "keys": "/codex <action> ...", "desc": "Bind, steer, and inspect the Codex app-server harness", "usage": "Actions include status, threads, resume, model, fast, permissions, compact, review, mcp, skills, and more." }, { "keys": "/login [codex|openai|openai-codex]", "desc": "Pair Codex/OpenAI login from a private chat or Web UI session", "usage": "Owner/admin only" }, { "keys": "/model [name|#|status] [-s|--session]", "desc": "Show or select a model", "usage": "Direct owner/admin selections request a configured-default update; -s changes only this session" }, { "keys": "/models [provider] [page] [limit=<n>|all]", "desc": "List configured/auth-available providers or models", "usage": "Type in any connected chat channel or the Control UI." }, { "keys": "/queue <mode>", "desc": "Manage active-run queue behavior", "usage": "See Queue and Queue steering" }, { "keys": "/steer <message>", "desc": "Inject guidance into the active run", "usage": "Alias: /tell. See Steer" }, { "keys": "/help", "desc": "Show the short help summary", "usage": "Type in any connected chat channel or the Control UI." }, { "keys": "/commands", "desc": "Show the generated command catalog", "usage": "Type in any connected chat channel or the Control UI." }, { "keys": "/tools [compact|verbose]", "desc": "Show what the current agent can use right now", "usage": "Type in any connected chat channel or the Control UI." }, { "keys": "/status", "desc": "Show execution/runtime status, Gateway and system uptime, plugin health, plus provider usage/quota", "usage": "Type in any connected chat channel or the Control UI." }, { "keys": "/status plugins", "desc": "Show detailed plugin health: load errors, quarantines, channel plugin failures, dependency issues, compatibility notices", "usage": "Requires commands.plugins: true" }, { "keys": "/diagnostics [note]", "desc": "Owner-only support-report flow", "usage": "Asks for exec approval every time" }, { "keys": "/openclaw <request>", "desc": "Run the OpenClaw setup and repair helper from an owner DM", "usage": "Type in any connected chat channel or the Control UI." }, { "keys": "/tasks", "desc": "List active/recent background tasks for the current session", "usage": "Type in any connected chat channel or the Control UI." }, { "keys": "/context [list|detail|map|json]", "desc": "Explain how context is assembled", "usage": "Type in any connected chat channel or the Control UI." }, { "keys": "/whoami", "desc": "Show your sender id", "usage": "Alias: /id" }, { "keys": "/usage off|tokens|full|reset|cost", "desc": "Control the per-response usage footer (reset/inherit/clear/default clears the session override to re-inherit the...", "usage": "Type in any connected chat channel or the Control UI." }, { "keys": "/skill <name> [input]", "desc": "Run a skill by name", "usage": "Type in any connected chat channel or the Control UI." }, { "keys": "/learn [request]", "desc": "Draft one reviewable skill from the current conversation or named sources through Skill Workshop", "usage": "Type in any connected chat channel or the Control UI." }, { "keys": "/loop [interval] <prompt>", "desc": "Owner-only", "usage": "Repeat a prompt in this conversation; omit the interval for self-paced checks" }, { "keys": "/loop status", "desc": "Owner-only", "usage": "List loops bound to this conversation" }, { "keys": "/loop stop [name]", "desc": "Owner-only", "usage": "Stop matching loops bound to this conversation" }, { "keys": "/allowlist [list|add|remove] ...", "desc": "Manage allowlist entries", "usage": "Text-only" }, { "keys": "/approve <id> <decision>", "desc": "Resolve exec or plugin approval prompts", "usage": "Type in any connected chat channel or the Control UI." }, { "keys": "/btw <question>", "desc": "Ask a side question without changing session context", "usage": "Alias: /side. See BTW" }, { "keys": "/subagents list|log|info", "desc": "Inspect sub-agent runs for the current session", "usage": "Type in any connected chat channel or the Control UI." }, { "keys": "/focus <target>", "desc": "Bind the current Discord thread or Telegram topic to a session target", "usage": "Type in any connected chat channel or the Control UI." }, { "keys": "/unfocus", "desc": "Remove the current thread binding", "usage": "Type in any connected chat channel or the Control UI." }, { "keys": "/agents", "desc": "List thread-bound agents for the current session", "usage": "Type in any connected chat channel or the Control UI." }, { "keys": "/config show|get|set|unset", "desc": "commands.config: true | Read or write openclaw.json", "usage": "Owner-only" }, { "keys": "/mcp show|get|set|unset", "desc": "commands.mcp: true | Read or write OpenClaw-managed MCP server config", "usage": "Owner-only" }, { "keys": "/debug show|set|unset|reset", "desc": "commands.debug: true | Runtime-only config overrides", "usage": "Owner-only" }, { "keys": "/restart", "desc": "commands.restart: true (default) | Restart OpenClaw", "usage": "Type in any connected chat channel or the Control UI." }, { "keys": "/send on|off|inherit", "desc": "owner | Set send policy", "usage": "Type in any connected chat channel or the Control UI." }, { "keys": "/activation mention|always", "desc": "Set group activation mode", "usage": "Type in any connected chat channel or the Control UI." }, { "keys": "/bash <command>", "desc": "Run a host shell command", "usage": "Alias: ! <command>. Requires commands.bash: true" } ] }, { "name": "Subcommand Families", "shortcuts": [ { "keys": "/tools ...", "desc": "What the agent can use now", "usage": "Results are session-scoped. Changing agent, channel, thread, sender" }, { "keys": "/loop ...", "desc": "Recurring conversation work", "usage": "Subcommand family; run without arguments to see current state." }, { "keys": "/model ...", "desc": "Model selection", "usage": "Direct owner/admin `/model <model>` requests **default scope**: it changes this session and starts a best-effort configured-default update. Adding `-s` uses **session scope**: only this sess" }, { "keys": "/config ...", "desc": "On-disk config writes", "usage": "Config is validated before write. Invalid changes are rejected. `/config`" }, { "keys": "/mcp ...", "desc": "MCP server config", "usage": "Subcommand family; run without arguments to see current state." }, { "keys": "/debug ...", "desc": "Runtime-only overrides", "usage": "Subcommand family; run without arguments to see current state." }, { "keys": "/plugins ...", "desc": "Plugin management", "usage": "Gateways automatically because plugin source modules changed. Trusted ClawHub" }, { "keys": "/trace ...", "desc": "Plugin trace output", "usage": "Subcommand family; run without arguments to see current state." }, { "keys": "/btw ...", "desc": "Side questions", "usage": "In the Control UI, `/btw` and `/side` open the session rail and ask its" } ] }, { "name": "openclaw CLI", "shortcuts": [ { "keys": "openclaw setup", "desc": "And `openclaw onboard` verify inference first, then start OpenClaw for Gateway, workspace, channels, skills, and...", "usage": "Run in a terminal on the Gateway host." }, { "keys": "openclaw setup --baseline", "desc": "Creates the baseline config and workspace without walking the guided onboarding flow", "usage": "Run in a terminal on the Gateway host." }, { "keys": "openclaw configure", "desc": "Changes targeted parts of an existing setup: model auth, gateway, channels, plugins, or skills", "usage": "Run in a terminal on the Gateway host." }, { "keys": "openclaw channels add", "desc": "Configures channel accounts after the baseline exists; a channel selection alone uses guided setup, while account,...", "usage": "Run in a terminal on the Gateway host." }, { "keys": "openclaw status --usage", "desc": "Show Gateway status including usage", "usage": "Run in a terminal on the Gateway host." }, { "keys": "openclaw update", "desc": "Update OpenClaw to the latest release", "usage": "Run in a terminal on the Gateway host." } ] }, { "name": "Hook Events & CLI", "shortcuts": [ { "keys": "command:new", "desc": "Fires when the /new command is issued", "usage": "Hooks subscribe to a specific key from the event table, declared in HOOK.md as events: [command:new]." }, { "keys": "command:reset", "desc": "Fires when the /reset command is issued", "usage": "Specific keys are preferred over the bare family name to reduce overhead." }, { "keys": "command:stop", "desc": "Fires when the /stop command is issued", "usage": "Handlers should filter events early and return immediately if not relevant." }, { "keys": "command", "desc": "Any command event - general listener for the whole family", "usage": "Bare family names (command, session, agent, gateway, message) receive every action in that family." }, { "keys": "session:auto-reset", "desc": "A daily or idle reset replaces the current session", "usage": "OpenClaw core emits nothing outside the documented table; unknown names leave a hook silently dead." }, { "keys": "session:compact:before", "desc": "Before compaction summarizes history", "usage": "The hook loader logs a warning for typo event names such as command:nwe." }, { "keys": "session:compact:after", "desc": "After compaction completes", "usage": "Pair with session:compact:before to bracket a compaction." }, { "keys": "session:patch", "desc": "When session properties are modified", "usage": "Part of the session event family." }, { "keys": "agent:bootstrap", "desc": "Before workspace bootstrap files are injected", "usage": "The only documented agent-family event key." }, { "keys": "gateway:startup", "desc": "After channels start and hooks are loaded", "usage": "Restarting the gateway process reloads hooks." }, { "keys": "gateway:shutdown", "desc": "When gateway shutdown begins", "usage": "Keep handlers fast - hooks run during command processing." }, { "keys": "gateway:pre-restart", "desc": "Before an expected gateway restart", "usage": "Distinct from gateway:shutdown, which covers full shutdown." }, { "keys": "message:received", "desc": "Inbound message from any channel", "usage": "Part of the message event family." }, { "keys": "message:transcribed", "desc": "After audio transcription completes", "usage": "Fires only for audio messages that go through transcription." }, { "keys": "message:preprocessed", "desc": "After media and link preprocessing completes or is skipped", "usage": "Fires either way, so handlers see every inbound message once preprocessing resolves." }, { "keys": "message:sent", "desc": "Outbound send attempted", "usage": "context.success carries the result of the send attempt." }, { "keys": "openclaw hooks list", "desc": "List all discovered hooks", "usage": "Add --eligible, --verbose, or --json. A hook must show here to be enabled." }, { "keys": "openclaw hooks info <hook-name>", "desc": "Show detailed info about a hook", "usage": "Flags unknown event names, so a hook that never runs is diagnosable." }, { "keys": "openclaw hooks check", "desc": "Show the eligibility summary", "usage": "Eligibility fails on missing binaries (PATH), environment variables, config values, or OS compatibility." }, { "keys": "openclaw hooks enable <hook-name>", "desc": "Enable a hook", "usage": "A hook needs HOOK.md plus a handler file in its directory, e.g. ~/.openclaw/hooks/my-hook/." }, { "keys": "openclaw hooks disable <hook-name>", "desc": "Disable a hook", "usage": "Per-hook state lives under hooks.internal.entries in the OpenClaw config; extra directories via hooks.internal.load.extraDirs." } ] }, { "name": "Channel, Plugin & Runtime Commands", "shortcuts": [ { "keys": "/exec host=<auto|sandbox|gateway|node> security=<deny|allowlist|full> ask=<off|on-miss|always> node=<id>", "desc": "Show or set exec defaults", "usage": "Controls where and how shell execution runs for the session." }, { "keys": "/goal [status|start|edit|pause|resume|complete|block|clear] ...", "desc": "Manage the current session's durable goal", "usage": "Goal state persists across the session lifecycle." }, { "keys": "/acp spawn|cancel|steer|close|sessions|status|set-mode|set|cwd|permissions|timeout|model|reset-options|doctor|install|help", "desc": "Manage ACP sessions and runtime options", "usage": "Runtime controls require external owner or intern privileges." }, { "keys": "/tts on|off|status|chat|latest|provider|limit|summary|audio|help", "desc": "Control text-to-speech output", "usage": "Provider, limits, and summary behavior are configurable per session." }, { "keys": "/dreaming [on|off|status|help]", "desc": "Toggle memory dreaming", "usage": "Owner or Gateway admin only." }, { "keys": "/pair [qr|status|pending|approve|cleanup|notify]", "desc": "Manage device pairing", "usage": "Covers QR pairing, pending approvals, and cleanup." }, { "keys": "/voice status|list|set <voiceId>", "desc": "Manage Talk voice configuration", "usage": "Discord native command name: /talkvoice." }, { "keys": "/card ...", "desc": "Send LINE rich card presets", "usage": "LINE channel only." }, { "keys": "/dock-discord", "desc": "Switch the active session's reply route to Discord", "usage": "Alias: /dock_discord. Requires session.identityLinks; source sender and target peer must share an identity group." }, { "keys": "/dock-mattermost", "desc": "Switch the active session's reply route to Mattermost", "usage": "Alias: /dock_mattermost. Same identity-link requirement as other dock commands." }, { "keys": "/dock-slack", "desc": "Switch the active session's reply route to Slack", "usage": "Alias: /dock_slack. Same identity-link requirement as other dock commands." }, { "keys": "/dock-telegram", "desc": "Switch the active session's reply route to Telegram", "usage": "Alias: /dock_telegram. Same identity-link requirement as other dock commands." } ] } ] }, "nous_hermes": { "name": "Nous Hermes", "icon": "fas fa-scroll", "source": { "name": "Hermes 4 model card & Hermes Agent docs", "url": "https://huggingface.co/NousResearch/Hermes-4-405B" }, "categories": [ { "name": "Hermes 4 Prompt Format & Tool Calling", "shortcuts": [ { "keys": "<|start_header_id|>role<|end_header_id|>", "desc": "Llama 3.1 chat header tokens used by Hermes 4 405B", "usage": "Roles: system, user, assistant. Each turn ends with <|eot_id|>. Smaller Hermes 4 models use ChatML instead." }, { "keys": "<|eot_id|>", "desc": "End-of-turn token in the 405B prompt format", "usage": "Closes each header-delimited message." }, { "keys": "thinking=True", "desc": "Chat template flag that activates reasoning mode", "usage": "Pass to the tokenizer chat template; alternatively use the deep-thinking system prompt from the model card." }, { "keys": "<think> </think>", "desc": "Tags enclosing the model's internal reasoning", "usage": "Emitted when reasoning mode is active; strip them to get the final answer only." }, { "keys": "You are a deep thinking AI...", "desc": "Official reasoning-mode system prompt", "usage": "Full text on the model card. Additional system instructions before or after it adjust thinking effort, style, and format." }, { "keys": "<tools> </tools>", "desc": "System-prompt tags wrapping the JSON tool signatures", "usage": "Function definitions go inside these tags in the system message." }, { "keys": "<tool_call> </tool_call>", "desc": "Tags the model emits around a JSON function call", "usage": "Parse the JSON inside to execute the call." }, { "keys": "<tool_response> </tool_response>", "desc": "Tags wrapping the tool result you feed back", "usage": "Return the function output inside these tags in a tool role message." } ] }, { "name": "Session (CLI)", "shortcuts": [ { "keys": "/new [name] (alias: /reset )", "desc": "Start a new session (fresh session ID + history).", "usage": "Optional [name] sets the initial session title — e.g. /new my-experiment opens a fresh session already titled my-experiment so it's easy to find later with /resume or /sessions . Append now , --yes , or -y to skip the confirmation modal — e.g. /reset now , /new --yes my-experimen" }, { "keys": "/clear", "desc": "Clear screen and start a new session", "usage": "" }, { "keys": "/history", "desc": "Show conversation history (respects /timestamps )", "usage": "" }, { "keys": "/save", "desc": "Save the current conversation", "usage": "" }, { "keys": "/prompt (alias: /compose )", "desc": "Compose your next prompt in $EDITOR (markdown) instead of the inline input — useful for long, multi-line, or carefully-formatted prompts.", "usage": "" }, { "keys": "/retry", "desc": "Retry the last message (resend to agent)", "usage": "" }, { "keys": "/undo", "desc": "Remove the last user/assistant exchange", "usage": "" }, { "keys": "/title", "desc": "Set a title for the current session (usage: /title My Session Name)", "usage": "" }, { "keys": "/compress [here [N] | focus topic]", "desc": "Manually compress conversation context (flush memories + summarize).", "usage": "/compress here [N] summarizes everything except the most recent N exchanges (default 2), kept verbatim — pick your own compression boundary. A focus topic narrows what a full summary preserves." }, { "keys": "/rollback", "desc": "List or restore filesystem checkpoints (usage: /rollback [number])", "usage": "" }, { "keys": "/diff [staged|all|session] [--stat] [path...]", "desc": "Show git changes in the working directory.", "usage": "Default: unstaged changes plus untracked files. staged shows what's staged for commit, all everything since HEAD, and session the cumulative diff of everything Hermes changed here (from the earliest retained checkpoint baseline — requires checkpoints to be enabled; complements /r" }, { "keys": "/snapshot [create|restore <id>|prune] (alias: /snap )", "desc": "Create or restore state snapshots of Hermes config/state.", "usage": "create [label] saves a snapshot, restore <id> reverts to it, prune [N] removes old snapshots, or list all with no args." }, { "keys": "/stop", "desc": "Kill all running background processes", "usage": "" }, { "keys": "/queue <prompt> (alias: /q )", "desc": "Queue a prompt for the next turn (doesn't interrupt the current agent response).", "usage": "" }, { "keys": "/steer <prompt>", "desc": "Inject a mid-run note that arrives at the agent after the next tool call — no interrupt, no new user turn.", "usage": "The text is appended to the last tool result's content once the current tool completes, giving the agent new context without breaking the current tool-calling loop. Use this to nudge direction mid-task (e.g. \"focus on the auth module\" while the agent is running tests)." }, { "keys": "/goal <text>", "desc": "Set a standing goal Hermes works toward across turns — our take on the Ralph loop.", "usage": "After each turn an auxiliary judge model decides whether the goal is done; if not, Hermes auto-continues. Subcommands: /goal status , /goal pause , /goal resume , /goal clear . Budget defaults to 20 turns ( goals.max_turns ); any real user message preempts the continuation loop, " }, { "keys": "/subgoal <text>", "desc": "Append a user-supplied criterion to the active goal mid-loop.", "usage": "The continuation prompt surfaces all subgoals to the agent verbatim, and the judge factors them into its DONE/CONTINUE verdict — so the goal isn't marked done until the original goal and every subgoal are met. Subcommands: /subgoal (list), /subgoal remove <N> , /subgoal clear . R" }, { "keys": "/heartbeat every <interval> <prompt> (alias: /hb )", "desc": "Set a recurring prompt that re-enters this session as a normal user turn whenever it's idle and the interval has elapsed (min 60s; missed ticks coalesce).", "usage": "Subcommands: /heartbeat status , /heartbeat pause , /heartbeat resume , /heartbeat clear . Session-scoped and in-process — use hermes cron for durable isolated schedules. See Session Heartbeats ." }, { "keys": "/refine [focus]", "desc": "Run the background memory/skill self-improvement review now instead of waiting for the automatic post-turn trigger.", "usage": "Optional focus text steers the review (e.g. /refine save the deploy workflow as a skill ). Runs in a background fork against a conversation snapshot — the live session and prompt cache are untouched; results are reported when done." }, { "keys": "/moa <prompt>", "desc": "Run a single prompt through the default Mixture of Agents preset, then restore your current model.", "usage": "One-shot — does not change your session model." }, { "keys": "/resume [name]", "desc": "Resume a previously-named session", "usage": "" }, { "keys": "/sessions (TUI alias: /switch )", "desc": "Classic CLI: browse and resume previous sessions in an interactive picker.", "usage": "TUI: open the live session switcher for currently open TUI sessions. Use /sessions new in the TUI to start another live session immediately." }, { "keys": "/egress [status]", "desc": "Show Docker egress proxy status — enabled/configured/running state, credential source, token mappings, uncovered providers, and next remediation step.", "usage": "Works in CLI, TUI, Desktop chat, and messaging gateway." }, { "keys": "/redraw", "desc": "Force a full UI repaint (recovers from terminal drift after tmux resize, mouse selection artifacts, etc.)", "usage": "" }, { "keys": "/status", "desc": "Show session info — model, provider, profile, session ID, working directory, title, created/updated timestamps, token totals, agent-running state — followed by a local Session reca", "usage": "The recap is computed locally from the in-memory conversation; no LLM call, no prompt-cache impact." }, { "keys": "/context [all] (alias: /ctx )", "desc": "Visual context-window breakdown.", "usage": "On the CLI/TUI: a 5×20 glyph block grid (each cell ≈ 1% of the model window) plus an estimated per-category table — system prompt, tool definitions, rules, skills index, MCP, subagents, memory, conversation — versus free space. On messaging platforms: a usage gauge with auto-comp" }, { "keys": "/agents (alias: /tasks )", "desc": "Show active agents and running tasks across the current session.", "usage": "" }, { "keys": "/background <prompt> (alias: /bg , /btw )", "desc": "Run a prompt in a separate background session.", "usage": "The agent processes your prompt independently — your current session stays free for other work. Results appear as a panel when the task finishes. See CLI Background Sessions ." }, { "keys": "/branch [name] (alias: /fork )", "desc": "Branch the current session (explore a different path)", "usage": "" }, { "keys": "/worktree [new [name]|list]", "desc": "CLI only.", "usage": "Inspect or create isolated git worktrees mid-session (inspired by Copilot CLI's /worktree new ). Bare /worktree shows the active worktree; /worktree list lists the repo's worktrees; /worktree new [name] creates a worktree under .worktrees/ (branched from the freshly-fetched remot" }, { "keys": "/handoff <platform>", "desc": "CLI only.", "usage": "Hand the current session off to a messaging platform (Telegram, Discord, Slack, WhatsApp, Signal, Matrix). The gateway picks it up immediately, creates a fresh thread on platforms that support threads (Telegram topics, Discord text-channel threads, Slack message-anchored threads)" }, { "keys": "/journey [list|delete <id>|edit <id>] (aliases: /learning , /memory-graph )", "desc": "Open the learning journey timeline of learned skills + memories.", "usage": "Works in the classic CLI, as a TUI overlay, and in the desktop app (Star Map panel). Not available on messaging platforms. See Learning Journey ." } ] }, { "name": "Configuration (CLI)", "shortcuts": [ { "keys": "/config", "desc": "Show current configuration", "usage": "" }, { "keys": "/model [model-name]", "desc": "Show or change the current model.", "usage": "Supports: /model claude-sonnet-4 , /model provider:model (switch providers), /model custom:model (custom endpoint), /model custom:name:model (named custom provider), /model custom (auto-detect from endpoint), and user-defined aliases ( /model fav , /model grok — see Custom model " }, { "keys": "/codex-runtime [auto|codex_app_server|on|off]", "desc": "Toggle the optional Codex app-server runtime for OpenAI/Codex models.", "usage": "auto (default) uses Hermes' standard chat completions; codex_app_server hands turns to a codex app-server subprocess for native shell, apply_patch, ChatGPT subscription auth, and migrated Codex plugins. Effective on next session." }, { "keys": "/personality", "desc": "Set a predefined personality.", "usage": "/personality none (or default / neutral ) clears the overlay and returns to base behavior." }, { "keys": "/verbose", "desc": "Cycle tool progress display: off → new → all → verbose.", "usage": "Can be enabled for messaging via config." }, { "keys": "/focus [on|off|status]", "desc": "Toggle focus view — a display-only reduced-output mode showing just your prompt and the final response.", "usage": "Composes with /verbose : turning it on snaps tool progress to off and remembers your previous mode, and /focus off restores it. Each turn ends with a dim recovery line ( ⋯ 7 tool lines hidden · /focus off to show ) and a persistent ◉ focus badge sits in the status bar so you alwa" }, { "keys": "/fast [normal|fast|status]", "desc": "Toggle fast mode — OpenAI Priority Processing / Anthropic Fast Mode.", "usage": "Options: normal , fast , status ." }, { "keys": "/reasoning [level|show|hide|full|clamp] [--global]", "desc": "Manage reasoning effort and display.", "usage": "Levels include none / minimal / low / medium / high / xhigh / max / ultra . show / hide (or on / off ) toggle reasoning display; full and clamp adjust how reasoning is shown. --global persists effort to config." }, { "keys": "/skin", "desc": "Show or change the display skin/theme", "usage": "" }, { "keys": "/export [profile] [-o out.tar.gz]", "desc": "CLI only.", "usage": "Pack a profile into a shareable .tar.gz — skills, memory, persona, crons, plugins, settings, and (from the desktop) themes and layout. Credentials ( auth.json , .env ) are stripped. Defaults to the active profile and <name>.tar.gz in the current directory. Same archive as hermes " }, { "keys": "/import <archive.tar.gz> [--name <name>]", "desc": "CLI only.", "usage": "Install a profile archive as a new profile, inferring the name from the archive unless --name is given. Refuses to overwrite an existing profile and cannot import as default . Creates a shell wrapper when the name is free. See Export and import a profile file ." }, { "keys": "/statusbar (alias: /sb )", "desc": "Toggle the context/model status bar on or off", "usage": "" }, { "keys": "/battery [on|off|status]", "desc": "Toggle a color-coded battery read-out as the first status-bar element (off by default; no-op without a battery).", "usage": "" }, { "keys": "/voice [on|off|tts|status]", "desc": "Toggle CLI voice mode and spoken playback.", "usage": "Recording uses voice.record_key (default: Ctrl+B )." }, { "keys": "/yolo", "desc": "Toggle YOLO mode — skip all dangerous command approval prompts.", "usage": "" }, { "keys": "/approvals [manual|smart|off]", "desc": "Show or set the persistent dangerous-command approval mode.", "usage": "" }, { "keys": "/footer [on|off|status]", "desc": "Toggle the gateway runtime-metadata footer on final replies (shows model, context %, and cwd).", "usage": "" }, { "keys": "/busy [queue|steer|interrupt|status]", "desc": "CLI-only: control what pressing Enter does while Hermes is working — queue the new message, steer mid-turn, or interrupt immediately.", "usage": "" }, { "keys": "/indicator [kaomoji|emoji|unicode|ascii]", "desc": "CLI-only: pick the TUI busy-indicator style.", "usage": "" }, { "keys": "/timestamps [on|off|status]", "desc": "CLI-only: toggle [HH:MM] timestamps on messages and in /history .", "usage": "" }, { "keys": "/wake [on|off|status]", "desc": "CLI-only: toggle the \"Hey Hermes\" wake word listener.", "usage": "" } ] }, { "name": "Tools & Skills (CLI)", "shortcuts": [ { "keys": "/tools [list|disable|enable] [name...]", "desc": "Manage tools: list available tools, or disable/enable specific tools for the current session.", "usage": "Disabling a tool removes it from the agent's toolset and triggers a session reset." }, { "keys": "/toolsets", "desc": "List available toolsets", "usage": "" }, { "keys": "/browser [connect|disconnect|status]", "desc": "Manage a local Chromium-family CDP connection.", "usage": "connect attaches browser tools to a running Chrome, Brave, Chromium, or Edge instance (default: http://127.0.0.1:9222 ). disconnect detaches. status shows current connection. Auto-launches a supported Chromium-family browser if no debugger is detected." }, { "keys": "/skills", "desc": "Search, install, inspect, or manage skills from online registries.", "usage": "Also the review surface for the skill write-approval gate: /skills pending , /skills diff <id> , /skills approve <id> , /skills reject <id> , /skills approval on|off . See Gating agent skill writes ." }, { "keys": "/memory [pending|approve|reject|approval]", "desc": "Review pending memory writes staged by the write-approval gate ( memory.write_approval ) and toggle the gate.", "usage": "See Controlling memory writes ." }, { "keys": "/bundles", "desc": "List configured skill bundles — /<name> slash aliases that preload several skills at once.", "usage": "Configure under bundles: in ~/.hermes/config.yaml . See Skill Bundles ." }, { "keys": "/learn <what to learn from>", "desc": "Distill a reusable skill from anything you describe — a directory, a URL, the workflow you just walked the agent through, or pasted notes.", "usage": "Open-ended: the agent gathers the sources with its own tools and authors a SKILL.md following the house authoring standards. Works in the CLI, the messaging gateway, the TUI, and the dashboard Skills page." }, { "keys": "/init [notes]", "desc": "Generate or update AGENTS.md project instructions from a repo scan (port of Codex /init ).", "usage": "The agent inspects manifests, layout, and toolchain configs with its read-only tools, then writes a concise AGENTS.md — or, if one exists, merge-updates it preserving your content. Optional notes steer the emphasis. Works in the CLI, the messaging gateway, and the TUI." }, { "keys": "/cron", "desc": "Manage scheduled tasks (list, add/create, edit, pause, resume, run, remove)", "usage": "" }, { "keys": "/suggestions [accept|dismiss N|catalog|clear] (alias: /suggest )", "desc": "Review suggested automations.", "usage": "Use /suggestions to list pending suggestions, /suggestions accept <id> to create the proposed automation, /suggestions dismiss <id> to reject one, /suggestions catalog to add curated starter automations, and /suggestions clear to clear resolved suggestion records. Accepted jobs p" }, { "keys": "/blueprint [name] [slot=value ...] (alias: /bp )", "desc": "Set up an automation from a blueprint template.", "usage": "Bare /blueprint lists the catalog; /blueprint <name> starts a guided slot-filling flow on the next agent turn; /blueprint <name> slot=value ... creates the job directly." }, { "keys": "/curator", "desc": "Background skill maintenance — status , run , pin , archive .", "usage": "See Curator ." }, { "keys": "/kanban <action>", "desc": "Drive the multi-profile, multi-project collaboration board without leaving chat.", "usage": "Full hermes kanban surface is available: /kanban list , /kanban show t_abc , /kanban create \"title\" --assignee X , /kanban comment t_abc \"text\" , /kanban unblock t_abc , /kanban dispatch , etc. Multi-board support included: /kanban boards list , /kanban boards create <slug> , /ka" }, { "keys": "/reload-mcp (alias: /reload_mcp )", "desc": "Reload MCP servers from config.yaml", "usage": "" }, { "keys": "/reload-skills (alias: /reload_skills )", "desc": "Re-scan ~/.hermes/skills/ for newly installed or removed skills", "usage": "" }, { "keys": "/reload", "desc": "Reload .env variables into the running session (picks up new API keys without restarting)", "usage": "" }, { "keys": "/plugins", "desc": "List installed plugins and their status", "usage": "" }, { "keys": "/pet [list|<slug>]", "desc": "Toggle or adopt a petdex mascot.", "usage": "/pet toggles the pane, /pet list shows installed pets, /pet <slug> adopts a specific one." }, { "keys": "/hatch <description> (alias: /generate-pet )", "desc": "Generate a brand-new petdex pet from a text description, using the configured image backend (OpenRouter / Nous Portal).", "usage": "See Pets ." } ] }, { "name": "Info & Account (CLI)", "shortcuts": [ { "keys": "/help", "desc": "Show available commands, grouped by category.", "usage": "Core commands are shown by default with skill commands collapsed to a one-line count; /help skills lists all skill commands, and /help <text> filters commands (and matching skills) by substring." }, { "keys": "/palette", "desc": "Open the fuzzy command palette (also Ctrl+P ) — type to filter all commands + skills, ↑/↓ to move, Enter to insert the selected command into the composer (never auto-runs), Esc to ", "usage": "Matching is ranked by command name first, so a short query stays precise." }, { "keys": "/version", "desc": "Show Hermes Agent version, build, and environment info.", "usage": "" }, { "keys": "/whoami", "desc": "Show your slash command access level (admin / user).", "usage": "" }, { "keys": "/usage", "desc": "Show token usage, cost breakdown, session duration, and — when available from the active provider — an Account limits section with remaining quota / credits / plan usage pulled liv", "usage": "" }, { "keys": "/topup", "desc": "Show your Nous balance and manage billing on the portal (replaces the old /credits and /billing commands).", "usage": "" }, { "keys": "/subscription (alias: /upgrade )", "desc": "CLI only.", "usage": "View your Nous plan and change it in the browser." }, { "keys": "/insights", "desc": "Show usage insights and analytics (last 30 days)", "usage": "" }, { "keys": "/update", "desc": "Update Hermes Agent to the latest version.", "usage": "" }, { "keys": "/platforms (alias: /gateway )", "desc": "Show gateway/messaging platform status (CLI-only summary view).", "usage": "" }, { "keys": "/paste", "desc": "Attach a clipboard image", "usage": "" }, { "keys": "/copy [number]", "desc": "Copy the last assistant response to clipboard (or the Nth-from-last with a number).", "usage": "CLI-only." }, { "keys": "/image <path>", "desc": "Attach a local image file for your next prompt.", "usage": "" }, { "keys": "/debug", "desc": "Upload debug report (system info + logs) and get shareable links.", "usage": "Also available in messaging." }, { "keys": "/profile", "desc": "Show active profile name and home directory", "usage": "" } ] }, { "name": "Exit (CLI)", "shortcuts": [ { "keys": "/quit", "desc": "Exit the CLI (also: /exit ).", "usage": "" } ] }, { "name": "Messaging-Only Commands", "shortcuts": [ { "keys": "/start", "desc": "Platform-protocol command.", "usage": "Many chat platforms (Telegram, Discord, …) send /start automatically the first time a user opens a bot conversation. Hermes acknowledges the ping silently — no agent reply, no session burn — so first-contact handshakes don't waste a turn. You can also send it explicitly to confir" }, { "keys": "/sethome (alias: /set-home )", "desc": "Mark the current chat as the platform home channel for deliveries.", "usage": "" }, { "keys": "/topic [off|help|session-id]", "desc": "Telegram DM only.", "usage": "Manage user-managed multi-session topic mode. /topic enables it or shows status; /topic off disables it and clears bindings; /topic help shows usage; /topic <session-id> inside a topic restores a previous session. See Multi-session DM mode ." }, { "keys": "/platform <list|pause|resume> [name]", "desc": "Operate a running gateway platform right from chat.", "usage": "/platform list shows every adapter and its state (running, paused-by-breaker, manually-paused); /platform pause <name> stops dispatching new messages to that adapter without unloading it; /platform resume <name> re-enables it and clears a tripped circuit breaker once the upstream" }, { "keys": "/commands [page]", "desc": "Browse all commands and skills (paginated).", "usage": "" }, { "keys": "/approve [session|always]", "desc": "Approve and execute a pending dangerous command.", "usage": "session approves for this session only; always adds to permanent allowlist." }, { "keys": "/deny", "desc": "Reject a pending dangerous command.", "usage": "" }, { "keys": "/restart", "desc": "Gracefully restart the gateway after draining active runs.", "usage": "When the gateway comes back online, it sends a confirmation to the requester's chat/thread." }, { "keys": "/<skill-name>", "desc": "Invoke any installed skill by name.", "usage": "" } ] } ] }, "mcp": { "name": "MCP (Model Context Protocol)", "icon": "fas fa-plug", "source": { "name": "Claude Code Docs - MCP", "url": "https://code.claude.com/docs/en/mcp" }, "categories": [ { "name": "claude mcp CLI", "shortcuts": [ { "keys": "claude mcp add <name> ...", "desc": "Register an MCP server with Claude Code", "usage": "Local stdio by default; --transport http or sse for remote servers, with -- separating the launch command for stdio." }, { "keys": "claude mcp add-json <name> '{...}'", "desc": "Register a server from a JSON definition", "usage": "Paste the same JSON shape used in .mcp.json." }, { "keys": "claude mcp list", "desc": "List all configured servers", "usage": "Shows every server visible in the current scope hierarchy." }, { "keys": "claude mcp get <name>", "desc": "Show details for one server", "usage": "Includes transport, scope, and status." }, { "keys": "claude mcp remove <name>", "desc": "Remove a configured server", "usage": "Takes the server name shown by claude mcp list." }, { "keys": "claude mcp login <name> / logout <name>", "desc": "Authenticate or sign out of a remote server from the command line", "usage": "OAuth flow runs in the browser unless --no-browser is set." }, { "keys": "claude mcp reset-project-choices", "desc": "Reset approval choices for project-scoped .mcp.json servers", "usage": "Claude prompts again before using project-scoped servers." }, { "keys": "claude mcp serve", "desc": "Run Claude Code itself as a stdio MCP server", "usage": "Prints nothing on start; other applications connect to it as a server." } ] }, { "name": ".mcp.json Configuration Fields", "shortcuts": [ { "keys": "mcpServers", "desc": "Top-level object in .mcp.json holding all server definitions", "usage": "Each key is a server name mapping to its config object." }, { "keys": "command / args", "desc": "Launch command and arguments for a local stdio server", "usage": "Example: \"command\": \"npx\", \"args\": [\"-y\", \"@modelcontextprotocol/server-github\"]." }, { "keys": "env", "desc": "Environment variables passed to a stdio server", "usage": "Object of KEY: value pairs; supports expansion like ${VAR} and ${VAR:-default}." }, { "keys": "type / url", "desc": "Transport type and endpoint for a remote server", "usage": "\"type\": \"http\" or \"sse\" with the server URL." }, { "keys": "headers", "desc": "Custom HTTP headers sent to a remote server", "usage": "Used for API keys or bearer tokens on http/sse transports." }, { "keys": "${VAR} / ${VAR:-default}", "desc": "Environment variable expansion inside .mcp.json", "usage": "Expands in command, args, env, url, and headers; the :- form supplies a default." }, { "keys": ".mcp.json", "desc": "Project-scope server file committed at the repository root", "usage": "Claude prompts for approval before using servers from it; reset with claude mcp reset-project-choices." } ] }, { "name": "Scopes, Transports & Flags", "shortcuts": [ { "keys": "--scope local|project|user", "desc": "Where a server definition is stored", "usage": "local is private to you in this project (default); project writes .mcp.json; user applies across all your projects." }, { "keys": "--transport http|sse", "desc": "Remote transport selection on claude mcp add", "usage": "Omit for local stdio; WebSocket servers use a ws:// URL." }, { "keys": "--env KEY=value", "desc": "Set an environment variable for a stdio server at add time", "usage": "Repeatable." }, { "keys": "--header \"Name: value\"", "desc": "Attach a custom header to a remote server at add time", "usage": "Repeatable; the usual carrier for API keys." }, { "keys": "--callback-port / --client-id / --client-secret", "desc": "Fixed OAuth callback port and pre-configured OAuth credentials", "usage": "For remote servers whose OAuth setup does not support dynamic registration." }, { "keys": "--no-browser", "desc": "Print the OAuth URL instead of opening a browser", "usage": "Pair with claude mcp login on headless machines." }, { "keys": "--mcp-config <file>", "desc": "Load MCP servers from a JSON file for this run", "usage": "Used with claude -p runs and the Agent SDK." } ] }, { "name": "Environment Variables", "shortcuts": [ { "keys": "MAX_MCP_OUTPUT_TOKENS", "desc": "Raise the MCP tool output limit", "usage": "Claude warns past 10,000 tokens and truncates at 25,000 by default." }, { "keys": "CLAUDE_CODE_MCP_TOOL_IDLE_TIMEOUT", "desc": "Idle timeout for MCP tool calls", "usage": "Defaults to 30 minutes for stdio servers; before v2.1.203 stdio was exempt." }, { "keys": "CLAUDE_CODE_MCP_AUTO_BACKGROUND_MS", "desc": "Threshold before a long MCP tool call is moved to the background", "usage": "Automatic backgrounding of long tool calls." }, { "keys": "MCP_CLIENT_SECRET", "desc": "Pre-configured OAuth client secret for a remote server", "usage": "Paired with --client-id when dynamic registration is unavailable." }, { "keys": "CLAUDE_CODE_DISABLE_BACKGROUND_TASKS", "desc": "Disable automatic backgrounding entirely", "usage": "Set to 1 to keep every tool call in the foreground." } ] }, { "name": "In-Session Usage", "shortcuts": [ { "keys": "/mcp", "desc": "In-session MCP menu: server status, auth, tools, resources", "usage": "Also where organization-managed connector controls surface." }, { "keys": "@server:resource", "desc": "Reference an MCP resource in the prompt", "usage": "Pulls the resource content into context." }, { "keys": "/mcp__server__prompt", "desc": "Run an MCP prompt exposed by a server as a slash command", "usage": "Arguments follow the command like any other slash command." } ] } ] }, "agent_files": { "name": "Agent Instruction Files", "icon": "fas fa-file-lines", "source": { "name": "AGENTS.md - Official spec", "url": "https://agents.md/" }, "categories": [ { "name": "Cross-Tool Standard", "shortcuts": [ { "keys": "AGENTS.md", "desc": "Open cross-tool instruction file: a README for agents", "usage": "Read by Codex, Cursor, Gemini CLI, Aider, Zed, Warp, Devin, Copilot coding agent, Factory, Jules, opencode, Windsurf and more. Plain Markdown, no required fields." }, { "keys": "AGENTS.md (nested)", "desc": "Per-package instruction files in a monorepo", "usage": "Agents read the nearest AGENTS.md up the directory tree; the closest one takes precedence, so each subproject can ship its own." } ] }, { "name": "Tool-Specific Files", "shortcuts": [ { "keys": "CLAUDE.md", "desc": "Claude Code project memory file", "usage": "Loaded at session start from the project root and parent directories; edit in-session with the /memory command documented on our Claude Code page." }, { "keys": "~/.claude/CLAUDE.md", "desc": "User-level Claude Code memory", "usage": "Applies across all your projects; project files add to it." }, { "keys": ".cursor/rules/*.mdc", "desc": "Cursor project rules (current format)", "usage": "Rule files with metadata controlling when each rule applies." }, { "keys": ".cursorrules", "desc": "Cursor legacy single-file rules", "usage": "Still read for backwards compatibility; new projects should use .cursor/rules/." }, { "keys": ".github/copilot-instructions.md", "desc": "GitHub Copilot repository-wide custom instructions", "usage": "Applies to Copilot Chat and the coding agent for that repository." }, { "keys": "*.instructions.md", "desc": "Copilot scoped instruction files", "usage": "Per-path instructions with applyTo front matter, alongside the repository-wide file." }, { "keys": "GEMINI.md", "desc": "Gemini CLI context file", "usage": "Project instructions for Gemini CLI; it also reads AGENTS.md." }, { "keys": "CONVENTIONS.md", "desc": "Aider coding conventions file", "usage": "Loaded with --read or listed in .aider.conf.yml so it is marked read-only for the LLM." } ] }, { "name": "Compatibility Patterns", "shortcuts": [ { "keys": "ln -s AGENTS.md CLAUDE.md", "desc": "Symlink pattern: keep one instruction source for tools with their own filename", "usage": "A single AGENTS.md stays canonical while filename-specific tools follow the link." } ] } ] } } }