Show HN: Crust – A CLI framework for TypeScript and Bun(github.com/chenxin-yan)
92 points by jellyotsiro 5 days ago | 41 comments
- camkego 4 days agoThis looks useful. But, it's interesting how the backend-world and front-end world keep diverging. I must admit, I had no idea what this was from the title. "CLI framework"? But in backend-land, these would typically be called "argument parsers" or "command line argument parsers". But maybe I am missing some of the functionality.[-]
- embedding-shape 4 days agoBoth in the frontend and the backend, I've usually used "If it calls your code, it's a framework, if you call its code, it's a library", and would seem to fit here too. An argument parser you'd call from your main method, then do stuff with what it returns. In Crust, it seems you instead setup the command + what will happen when it's called, then let the framework call your code.[-]
- codybontecou 4 days agoThat’s… actually a great definition. I’m going to try to retain that.[-]
- jazzypants 4 days agoThis is classically called "Inversion of Control"[0] or the "Hollywood Principle"[1] as in "Don't call us-- we'll call you".
[0] - https://martinfowler.com/bliki/InversionOfControl.html [1] - https://wiki.c2.com/?HollywoodPrinciple
- jellyotsiro 4 days agogood point.
we’re using “framework” intentionally because it goes beyond argument parsing. crust handles parsing, but also:
type inference across args + flags end to end compile-time validation (so mistakes fail before runtime) plugin system with lifecycle hooks (help, version, autocomplete, etc.) composable modules (prompts, styling, validation, build tooling) auto-generates agent skills and modules from the CLI definitions
so it sits a layer above a traditional arg parser like yargs or commander, closer to something like oclif, but much lighter and bun-native.
- chenxin-yan 4 days agoHi, I called it "CLI framework" because it is more of a ecosystem of modules that contains everything you need to build a CLI, argument parsing is just part of it. The @crustjs/core module is the argument parser, and there are more modules such as @crustjs/skills that would derive agent skills from your command definition, @crustjs/store that state persistent and so on
- lozf 4 days agoalso: no "C", and no "rust", despite being a portmanteau of both these other languages names :)
- hdjrudni 3 days agoI was looking for something like this.
Does the help plugin not support color?
Looks like the spacing is messed up too. I just converted my app to use it and its coming out like
``` COMMANDS: export-schemaExport table definitions from existing database to YAML export-dataExport table data in CSV format import-dataImport table data from CSV file schema-sqlConvert YAML schema back to MySQL export-usersExport users in YAML format users-sql Convert users.yaml back into SQL export-allExport all data from host export-all-tgzExport all data from host databases-sqlConvert databases.yaml back into SQL export-typescriptExport TypeScript interfaces ```
i.e. there's no space after `export-schema` it just goes immediately to the description.
[-]- chenxin-yan 3 days agoI will add color support for help plugin later. open a issue if you found bugs or improvement
- derodero24 3 days agoThe plugin system and compile-time validation are nice touches. My main concern would be the standalone binary size — 58-109MB is a lot for a CLI tool. Most Go CLIs land around 10-20MB and even that gets complaints. Is there a way to strip unused features, or is this mostly the Bun runtime being bundled?[-]
- babarot 3 days agoThe binary size is my main hesitation with Bun-based CLIs too. For comparison, a typical Go CLI with cobra compiles to ~10MB statically linked, and you get cross-compilation for free. The plugin system and compile-time validation here are genuinely nice though — Go's CLI ecosystem doesn't have anything equivalent to that.[-]
- derodero24 2 days agoYeah exactly. Go's ~10MB binaries with dead-simple cross-compilation is tough to compete with. I think Bun makes more sense for internal tools where you control the install and care more about the plugin ecosystem than distribution size.
- GutenYe 4 days agoLooks cool. If anyone is interested in a simple option with autocomplete working out of the box and no extra bells and whistles, feel free to check out my project: https://github.com/gutenye/script.js
- bennettpompi1 4 days agothis is cool! i'd recommend fleshing out the README. Clicked on the link before the discussion and was a tad confused.[-]
- chenxin-yan 4 days agoHi, I will update the README.md to make it more informative. The reason I left it kinda empty is because curst has a website that have more details about this project at crustjs.com. I just had the link in README.md for now
- jellyotsiro 4 days agowill fix in the next hour!
- landl0rd 4 days agoIs there an examples section? Would be helpful to see a demo[-]
- jellyotsiro 4 days agoone of the examples would be trynia.ai (search and index api for ai agents)
here is github: github.com/nozomio-labs/nia-cli
- qyron 4 days agoAny plans to support Node.js? Also some comparison (at least design choices) with existing frameworks would be nice.[-]
- chenxin-yan 4 days agoTechnically most modules would work with node.js as they are not using any bun specific APIs. The reason for crust to be all in bun is because bun can compile your cli into binaries for distribution which powers curst build. The idea is that since you will have bun bundled with your CLI to end user. the developer does have to worry about the end users don't have bun installed and use Bun api freely when building.
- iktakahiro 2 days agoAs a Bun user, this caught my eye. Gonna give it a try!
- rgbrgb 4 days agonice, congrats on launch. To get an idea... what's the size of a standalone hello world cli binary?[-]
- jellyotsiro 4 days agotens of KBs (v small)[-]
- rgbrgb 4 days agoIsn't a standalone Bun binary like 50MB because it has to bundle the runtime? How could this get smaller?[-]
- chenxin-yan 4 days agoHi, the creator of crust here, the binary size varies between platforms. With the hello world cli, the smallest, on darwin-arm64 it is 58.1M, the largest on windows-x64 is 109M. hope this helps!
- matt_kantor 4 days ago> Versions before 1.0 do not strictly follow semantic versioning.
Sorry for being nitpicky, but yes they do. Semantic versioning[0] allows arbitrary changes while the major version is 0:
> Major version zero (0.y.z) is for initial development. Anything MAY change at any time. The public API SHOULD NOT be considered stable.
[0]: https://semver.org/
[-]- chenxin-yan 4 days agoHi, the comment I left in README.md is just to warn user that do expect breaking changes before 1.0 for THIS PROJECT specifically. there is no implication that semver as a standard is promoting arbitrary changes/version before 1.0.[-]
- matt_kantor 4 days agoI get that, and it's a nice thing to warn users about. My nitpick was merely about the specific "do not strictly follow semantic versioning" phrasing. There's nothing you can do in a 0.y.z release which doesn't follow the SemVer spec (e.g. your next release could turn the project into a spell checker instead of a CLI framework and you'd still be in compliance).[-]
- chenxin-yan 4 days agoohh thank you for pointing that out. I just double checked the semver docs and it makes sense now. Something new I learned today
- jellyotsiro 4 days agothanks for the catch, what we meant is that we’re not committing to strict stability guarantees yet, so APIs may still change as we iterate toward 1.0.[-]
- matt_kantor 4 days agoI understand, but that's already implied by a 0.y.z version number.[-]
- olivia-banks 4 days agoI will say that this doesn't seem to be how semver is used in the wild, which I would argue is more important. I personally didn't know about this rule. Tons of Rust projects follow semver don't follow it either, and just stay on 0.x.y forever.[-]
- matt_kantor 4 days agoHow is it used in the wild, in your experience? Have you observed projects following some alternate set of rules?
I thought projects that stay on 0.x.y forever mostly do it because it means they're allowed to break things. Also, since 0.x.y means "anything goes", projects can introduce their own conventions within that range without violating the spec.
I know that some package managers (including Cargo and npm) confusingly treat 0.1.0 → 0.1.1 like a "minor" update, despite the spec. Is this what you're referring to?
[-]- olivia-banks 1 day agoYes, that was what I was referring to, although I thought the reason of staying at 0.y.z was more of a cultural one. v0, at least to me, implies that the API may change arbitrarily and quickly, but makes no assertions about the actual versioning scheme itself.
There's a website making fun of it: https://0ver.org/
- todteera 3 days agoseems pretty useful and easy to setup
- optivly 4 days agowow, cannot wait to start with this
- leontloveless 4 days ago[dead]
- rrojas-nexus 3 days ago[dead]
- kaihong_deng 3 days ago[dead]
- dnlzro 4 days agoPsst, the GitHub link in your post is broken (it should be https://github.com/chenxin-yan/crust).[-]
- dang 4 days agoFixed above. Thanks for the heads-up!
- jellyotsiro 4 days agothanks for flagging! the post itself works, just the link at the bottom