{children};
const P = ({ tok, val }) => {val};
// ----- Section content -----
const SECTIONS = {
overview: {
label: "overview.md",
icon: "doc",
crumbs: ["~", "sprite", "overview.md"],
render: ({ openTab }) => (
<>
Sprite (sp) is an intelligent directory navigator and command augmenter for Zsh. Jump to any folder by partial match, autocomplete paths inside any command, and bind your own shortcuts — all backed by a learning algorithm that adapts to how you actually work.
Modern repos sprawl. You spend more time typing cd ../../../ than running the command you actually wanted. Sprite folds that overhead away — type a fragment, hit Enter, you're there. Prefix any command with sp and the same matching engine completes paths inside it.
Open any file in the sidebar — or type sp <name> in the terminal below to navigate by name. Try{" "}
openTab("quickstart")} style={{ color: "var(--accent)", cursor: "pointer", textDecoration: "underline" }}>quick-start.sh,{" "}
openTab("shortcuts")} style={{ color: "var(--accent)", cursor: "pointer", textDecoration: "underline" }}>shortcuts.md, or{" "}
openTab("demo")} style={{ color: "var(--accent)", cursor: "pointer", textDecoration: "underline" }}>live-demo.term.
Three steps. One terminal restart. You'll be navigating by fragment before your coffee cools.
Pick your weapon. Both end at the same place.
Wires Zsh completion, drops the sp() function into your ~/.zshrc, and indexes your home directory.
{"\n"}
Type a fragment. Hit Enter. Or hit Tab for the menu.
{"\n"}
{"\n\n"}
{"\n"}
Bind a shortcut to your most-run command — see openTab("shortcuts")} style={{ color: "var(--accent)", cursor: "pointer", textDecoration: "underline" }}>shortcuts.md for the full system.
sp refresh.
The installer downloads the latest binary to ~/.local/bin, sets up Zsh completion, configures your .zshrc, and builds the initial directory database.
sp-binary to ~/.local/bin~/.zsh/completions/_spsp() function, and PATH export to ~/.zshrc
Available via the jlkendrick/tap Homebrew tap. Two flavors — pick whichever fits your muscle memory.
{"\n"}
After Homebrew finishes, wire up your shell and seed the directory database:
{"\n"}
sp-binary init adds the Sprite completion block and sp() function to your ~/.zshrc and builds the database from your home directory. The same step is repeated in the formula caveats.
For when you want to know — and own — every line that touches your shell config. There are two routes: semi-automatic (let sp-binary init finish the job) or fully manual.
{"\n"}
{"\n"}
Let sp-binary init install the completion script, edit ~/.zshrc, and seed the database in one go.
{"\n"}
Continue with the steps below if you want full control over every file.
{"\n"}
Add the following to your ~/.zshrc:
{"\n"}
{"\n\n"}
{"\n"}
{"\n"}
{"\n\n"}
{"\n"}
{"\n\n"}
{"\n\n"}
{"\n"}
{"\n"}
{"\n\n"}
{"\n"}
{"\n"}
)
},
features: {
label: "features/overview.md",
icon: "sparkle",
crumbs: ["~", "sprite", "features", "overview.md"],
render: () => (
<>
Each piece exists to remove a specific keystroke or context-switch. Together they collapse the gap between thinking of a directory and being inside it.
How Sprite decides what counts as a hit. Default is contains; switch via config.json.
How matches get ranked when there's more than one.
Append / to any path to bypass the database and browse the live filesystem instead.
{"\n"}
{"\n"}
)
},
shortcuts: {
label: "features/shortcuts.md",
icon: "key",
crumbs: ["~", "sprite", "features", "shortcuts.md"],
render: () => (
<>
A shortcut is an alias that knows about paths. Bind code to code, then sp code dirv resolves the path, expands, and runs.
{"\n"}
{"\n"}
Shortcuts use the same fuzzy completion as bare sp. A few bound above, in action:
{"\n"}
{"\n"}
{"\n\n"}
{"\n"}
{"\n"}
{"{}"} placeholder
Without {"{}"}, the resolved path is appended to the end of the command. Add {"{}"} to control exactly where it lands — including using it multiple times.
{"\n"}
{"\n\n"}
{"\n"}
{"\n"}
{"\n"}
{"\n"}
{"\n"}
{"\n\n"}
{"\n"}
{"\n\n"}
{"\n"}
sp add c "cursor") and you'll never type its name again.The terminal at the bottom of this window is real — well, real-ish. It runs a sandboxed simulation of Sprite against this very documentation. Every file in the sidebar is a navigable directory.
sp install and press Enter — quick-nav to the install tab.sp shor and press Tab — see the completion menu in action.sp ls to list everything in the current directory.sp list to see the bound shortcuts.help to see every supported command.
Sprite's config lives at ~/Library/Application Support/sprite/config.json. Edit it directly — changes take effect on the next command.
{"{\n"}
{"\n"}
{"\n"}
{"\n"}
{"\n"}
{"\n"}
{"\n"}
{"\n"}
{"\n"}
{"\n"}
{"\n"}
{"\n"}
{"\n"}
{"\n"}
{"\n"}
{"\n"}
{"\n"}
Four matching patterns — exact, prefix, suffix, contains — let you trim noise from the index. Defaults already exclude .git, node_modules, dist, target, virtual envs, and dotfile directories.
The root directory is the universe Sprite scans. Make it tight enough to be fast, broad enough to cover your actual work.
{"\n"}
{"\n"}
{"\n\n"}
{"\n"}
-api / -web patterns.
{"\n"}
{"\n"}
{"\n"}
sp refresh periodically — or just rely on the auto-refresh on terminal start.max_results to your screen size.max_history_size appropriately — larger means better predictions, more storage.-- to opt out of Sprite's command interpretation. sp -- build navigates to a directory called "build" instead of running the build subcommand.Most issues come from a missing PATH entry or a stale completion cache. The four sections below cover ~95% of reported problems.
~/.local/bin is in your PATH.fpath includes ~/.zsh/completions.compinit to rebuild the completion cache.sp-binary is executable: chmod +x ~/.local/bin/sp-binary.sp refresh manually.cat ~/Library/Application\ Support/sprite/config.json.sp build --root ~/your/root/path.
{"\n"}
which sp-binary.PATH in .zshrc: {'export PATH="$HOME/.local/bin:$PATH"'}.source ~/.zshrc.Still stuck? Open an issue on the{" "} GitHub repo — issues and PRs are welcome under the MIT license.
) } }; // ---------- Helper presentational components ---------- const CmdCard = ({ label, cmd, big }) => { const [copied, setCopied] = React.useState(false); const onCopy = () => { navigator.clipboard?.writeText(cmd).catch(() => {}); setCopied(true); setTimeout(() => setCopied(false), 1400); }; return ({desc}