Clyde Help

Clyde Help Articles

Command reference for Clyde, organized by workflow with syntax, options, examples, AI-ready JSON help, and safety notes.

Executive summary

Clyde is Starlit Digital's local MCP-client and Ollama harness for auditable repository feedback, source bundling, and NotebookLM sync. The official project homepage is sltd.ca/clyde. Source and project context live in the Clyde GitHub repository. Use clyde help --json for the structured AI-ready command catalog, clyde doctor --json for machine-readable local diagnostics, and clyde scan-report --json for repository-shape summaries.

Clyde terminal showing doctor diagnostics and repository scan report output
Clyde in action: local diagnostics, Ollama readiness, repository scan counts, and skip reasons before bundling or sync.
Human and AI readiness: every command has a human-readable article, CLI help path, explicit access/network notes, examples, and structured catalog metadata via clyde help --json.
Total commands20
Generated2026-09-04
SourceClyde CLI

Core#

CommandAccessNetworkPurpose
aboutRead-onlyNoneShow Clyde product details and official links.
helpRead-onlyNoneShow human-readable help or a JSON command catalog.

Packaging#

CommandAccessNetworkPurpose
completionRead-onlyNoneGenerate shell completion for Bash, Zsh, Fish, PowerShell, Elvish, Nushell, Xonsh, Tcsh, Clink, Yash, or Oil.

Diagnostics#

CommandAccessNetworkPurpose
doctorRead-onlyLocal OllamaCheck Clyde configuration, platform, PATH tools, Ollama, and optional repo scan readiness.

Configuration#

CommandAccessNetworkPurpose
configReads or writes local configNoneShow, initialize, or print the Clyde configuration path.
config initWrites local configNoneWrite Clyde's default configuration file.
config pathRead-onlyNonePrint the config file path Clyde will use.
config showRead-onlyNonePrint the effective Clyde configuration as JSON.

Interactive#

CommandAccessNetworkPurpose
tuiLocal interactiveOptional local OllamaOpen Clyde's dependency-free terminal UI.

Local Models#

CommandAccessNetworkPurpose
agentReads repo and sends selected contextLocal Ollama by defaultScan repository context and ask a local model for feedback.
askSends prompt to OllamaConfigured OllamaSend a direct prompt to the selected local Ollama model.
modelsRead-onlyLocal OllamaList local Ollama models and the selected default.

NotebookLM Sync#

CommandAccessNetworkPurpose
bookRead-onlyNoneGenerate a dated NotebookLM book title and slug.
syncUploads repository chunksNotebookLM backendUpload scanned repository chunks to NotebookLM after explicit approval.

Repository Bundles#

CommandAccessNetworkPurpose
bundleWrites local filesNoneWrite a local manifest and source chunks for review.
previewRead-onlyNoneReport included and skipped repository files before bundling or upload.
scan-reportRead-onlyNoneSummarize repository scan shape with largest files, extensions, skip reasons, and chunk counts.

Status#

CommandAccessNetworkPurpose
daemonStarts local serverLocalhost onlyStart the localhost-only JSON-RPC status daemon.
statusRead-onlyLocalhost by defaultRead Clyde daemon progress for a job.