run Documentation

The run tool executes functions defined in a Runfile, exposing them both to your terminal and to AI agents via the Model Context Protocol (MCP). It is built for fast startup, polyglot scripts, and discoverable tooling.

Who this is for

• Developers who want a single, typed catalog of project tasks.
• AI users who need MCP-exposed tools without revealing implementation details.
• Teams that mix shell automation with Python/Node snippets in one file.

How this documentation is organised

• Getting started — installation and your first Runfile.
• Runfile syntax — functions, namespaces, and signatures.
• Arguments — how parameters map to shell variables and defaults.
• Variables — environment handling and scope rules.
• Attributes and interpreters — @desc, @os, @shell, and shebang precedence.
• Polyglot commands — mixing languages inside a Runfile.
• Command composition — combining tasks and propagating exit codes.
• CLI usage — flags, output formats, completions, and REPL.
• MCP integration — exposing tools to AI agents safely.
• Recipes — ready-made Runfile snippets.
• Reference — attribute and environment variable quick lookups.
• FAQ — fast answers to common questions.