DevFoundry CLI
The devfoundry command-line interface provides access to the DevFoundry platform — scripts, local files, CI, and structured JSON output from the same DevFoundry Registry as every other surface.
What is the CLI?
DevFoundry CLI (@devfoundry-dev/cli) exposes all registered tools through the devfoundry command. It parses arguments, invokes the registry, and prints human-readable or JSON output.
Command name: Use devfoundry in scripts, documentation, and CI.
Scripts & CI
Pipe --json output into jq, GitHub Actions, or custom automation.
Local files
Optimize images, convert HTML, and validate JSON against paths on disk.
Same registry
One registered capability — DevFoundry CLI, DevFoundry API, DevFoundry MCP, and DevFoundry Website.
Installation
Requires Node.js 20+. Install globally from npm:
npm install -g @devfoundry-dev/cli
Verify the install:
devfoundry version devfoundry help
Screenshots: devfoundry web screenshot uses Playwright. After install, runnpx playwright install chromium once on your machine.
For development from source, see the repository README.
Shell completion
Tab completion for tools, actions, and flags — generated from the DevFoundry Registry at runtime. Supported shells: Bash, Zsh, Fish, and PowerShell.
devfoundry completion --help devfoundry completion zsh > ~/.zsh/completions/_devfoundry devfoundry completion fish > ~/.config/fish/completions/devfoundry.fish eval "$(devfoundry completion bash)"
Quick Start
devfoundry tools # List all tools and actions devfoundry doctor # Environment diagnostics devfoundry slugify run "Hello World" # Slugify text devfoundry json format package.json # Pretty-print JSON devfoundry image optimize logo.png # Optimize an image devfoundry web metadata https://example.com
Every command supports --help. Add --json for structured output suitable for scripting.
Optional shell alias
If you prefer a shorter command, you can add a shell alias — for example alias df=devfoundry in your shell profile. Ensure it does not conflict with other tools on your PATH.
Examples
# Image optimization devfoundry image optimize ./assets --out ./optimized devfoundry image optimize logo.png --out logo.webp # Favicon & OG images devfoundry image favicon source.png --out ./public devfoundry image og --title "Launch" --subtitle "DevFoundry" --out og.png # HTML & JSON devfoundry html markdown page.html --out page.md devfoundry json validate config.json devfoundry json format data.json --json # Web utilities devfoundry web metadata https://example.com devfoundry web screenshot https://example.com --out shot.png --full-page # Text utilities devfoundry slugify run "My Blog Post Title" devfoundry string case --to camel hello_world
More examples in examples/cli/ on GitHub.
Roadmap
- Stable v0.1.0 release after alpha feedback
- Plugin architecture for third-party registry tools
- GitHub Actions integration for CI workflows
Alpha status
The CLI is in public alpha. Core tools are stable enough for daily use, but command names, flags, and JSON shapes may evolve before v1.0. Report issues onGitHub or explore tools interactively on the website.
Also available: MCP server for AI-native editors · browser tools for quick workflows