Bombshell has docs!
Everything you need to build beautiful CLIs is now all in one place
We’re excited to announce the launch of our new documentation site. This site brings together comprehensive documentation for all of Bombshell’s CLI tools, making it easier for developers to build beautiful command-line interfaces.
Who This Is For
Our documentation is written for developers who want to build better CLI tools. Whether you’re creating a new CLI from scratch or improving an existing one, our docs provide clear, practical guidance. We write with developers in mind who may be:
- Learning CLI development for the first time
- Working quickly and need to find answers fast
- Reading in a non-native language
- Looking for practical examples they can copy and adapt
We keep our writing clear and straightforward. We use shorter sentences, simpler words, and clear examples. We avoid jargon when possible and explain technical terms when we use them.
What’s Included
The documentation site currently covers our three main libraries (Clack, Args, and Tab), but will continue to expand as our tools do.
Key Features
Our documentation site includes several features designed to help you learn and build:
Interactive Examples
Many code examples are interactive. You can see how Clack prompts work directly in your browser using WebContainers technology. This lets you experiment with the library before installing it.
TypeScript Support
All examples include TypeScript types. The documentation uses twoslash annotations to show type information inline, helping you understand what types each function expects and returns.
Clear Navigation
The site is organized by tool, with separate sections for basics, guides, and API references. Each section builds on previous content, making it easy to find what you need.
Practical Guides
Beyond API documentation, we include guides on best practices and real-world examples. These show you how to handle common scenarios like form validation, error handling, and progressive disclosure.
Why We Built This
Before launching this site, documentation for our tools was scattered across README files and GitHub repositories. This made it harder for developers to find what they needed. We wanted to create a single place where developers could:
- Learn how to use our tools quickly
- Find complete API references
- See working examples they could copy
- Understand best practices for CLI development
We also wanted documentation that matches how we think about CLI development. Our tools prioritize developer experience, type safety, and beautiful user interfaces. Our documentation reflects these values.
What’s Next
This is just the beginning.
We’re also always improving the documentation based on feedback. If you find something unclear or have suggestions, please open an issue or join our Discord.
Get Started
Ready to build better CLIs? Visit bomb.sh/docs to get started.
You can also find us on GitHub and Discord. We’d love to see what you build.
Acknowledgements
Thank you to the Astro docs team for consistently raising the bar on developer documentation and inspiring our docs principles. We hope to live up to your example!
Thanks to StackBlitz for making WebContainers available for open source usage. Support them!