CLI Reference
This document provides a comprehensive reference for all commands available in the ctxsift CLI.
ctxsift configure
Section titled “ctxsift configure”Run the guided setup to configure CtxSift’s behavior globally or for the current workspace.
ctxsift configure [OPTIONS]This command runs interactively, guiding you through:
- Selecting model execution paths (CPU, GPU, or Remote).
- Selecting specific models (e.g., GGUF files for CPU or HF repos for GPU).
- Configuring local daemon behavior.
- Resolving where to write the config file.
- Creating workspace database files and configuring gitignore settings.
- Installing the CtxSift skill for one or more supported agent hosts using a numbered multi-select flow, with scope and target-path prompts where needed.
Options
Section titled “Options”--write-ignore/--no-write-ignoreOverride whether configure automatically appends the.ctxsift/database directory to the workspace’s.gitignore. If not specified, CtxSift will prompt you interactively.
ctxsift compress
Section titled “ctxsift compress”Compress incoming stdin or command outputs under a natural language instruction.
# Pipe mode<command> | ctxsift compress --intent INTENT [OPTIONS] INSTRUCTION
# Command capture modectxsift compress --intent INTENT [OPTIONS] INSTRUCTION -- COMMAND [ARGS]...Arguments
Section titled “Arguments”INSTRUCTION(Required string) The natural language instruction specifying what patterns, errors, or structures the model should extract and keep in the summary.
Options
Section titled “Options”--intent(RequiredCompressionIntentenum value) Specifies the target output contract for the model. Options:summary: High-level plain text description for the current step.recall: Plain-text evidence optimized for laterctxsift recallmatches.exact-lines: Pulls verbatim lines from the input only.exact-format: Follows the instruction’s textual shape exactly.json: Returns valid JSON for machine consumption.yaml: Returns valid YAML for structured config-like output.table: Formats output as a markdown table.bullet-list: Formats output as a markdown bullet list.
--shellExecutes the command sequence after--in shell mode (e.g., handles wildcards, shell pipelines, and environment variables). Only applicable in command capture mode.--max-output-tokens(Integer) Overrides the default model output limit (e.g., sets output limit to1024tokens for this run).
Usage Examples
Section titled “Usage Examples”# Return only the failing pytest node ids verbatimpytest | ctxsift compress --intent exact-lines "return only the failing pytest node ids, one per line"
# Capture a build and return machine-readable diagnosticsctxsift compress --intent json "extract errors as JSON" -- pnpm buildctxsift recall
Section titled “ctxsift recall”Search the workspace’s database for previously compressed records matching a search query.
ctxsift recall [OPTIONS] QUERYArguments
Section titled “Arguments”QUERY(Required string) The search term, error code, command name, or natural language query to recall.
Options
Section titled “Options”--files(List of strings) Provide file paths to filter search results. Recall prioritizes records containing matches inside these specific files.--limit(Integer) Set the maximum number of results to display. Defaults to the configuredrecall.default_limit.
Usage Examples
Section titled “Usage Examples”# Recall build logs matching docker network settingsctxsift recall "docker connection timeout"
# Focus on auth failures in a specific filectxsift recall "expired token" --files tests/test_auth.pyctxsift doctor
Section titled “ctxsift doctor”Inspect the local environment’s health, dependencies, and configuration setup.
ctxsift doctorRuns diagnostic probes on core components (SQLite, Git, CUDA, PyTorch, LiteLLM, llama-cpp-python, bitsandbytes) to check if your current configuration is runnable.
ctxsift config
Section titled “ctxsift config”Directly inspect or edit configuration settings.
ctxsift config show
Section titled “ctxsift config show”Display the resolved configuration settings that CtxSift is currently using.
ctxsift config show [OPTIONS]- Options:
--global: Reads only the global configuration file (config.toml), ignoring any workspace-specific configurations.
ctxsift config set
Section titled “ctxsift config set”Write a configuration value for a key.
ctxsift config set [OPTIONS] KEY VALUE- Arguments:
KEY: The dot-separated configuration path (e.g.,local.deviceorremote.base_url).VALUE: The value to assign.
- Options:
--global: Writes the key-value pair to the globalconfig.tomlfile rather than the workspace config.
ctxsift daemon
Section titled “ctxsift daemon”Start, stop, and inspect background model serving daemons.
ctxsift daemon start
Section titled “ctxsift daemon start”Manually boot the daemons specified by the current active configuration.
ctxsift daemon startctxsift daemon status
Section titled “ctxsift daemon status”View the health, ports, and process IDs of running daemons.
ctxsift daemon status [OPTIONS]- Options:
--all: Lists statuses for all registered daemons on the machine, including those from other workspaces.
ctxsift daemon stop
Section titled “ctxsift daemon stop”Shut down running model daemons.
ctxsift daemon stop [OPTIONS]- Options:
--all: Shuts down all running daemons across the entire machine.