42 lines
810 B
Markdown
42 lines
810 B
Markdown
# CLI Template
|
|
|
|
A minimal CLI template using Stricli and Dax.
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
nix develop # optional: provides Node.js, TypeScript, biome
|
|
npm install
|
|
npm run build
|
|
node dist/index.mjs --help
|
|
```
|
|
|
|
Alternatively, use Nix directly:
|
|
|
|
```bash
|
|
nix run . -- --help # runs the CLI directly
|
|
nix shell . --command name-placeholder --help # provides CLI in PATH
|
|
```
|
|
|
|
## Development
|
|
|
|
Uses TypeScript and Biome for checks:
|
|
|
|
```bash
|
|
npm run check
|
|
```
|
|
|
|
## Renaming
|
|
|
|
To rename the CLI, edit the `name` field in `package.json`. Both the Nix package and the CLI will update automatically.
|
|
|
|
```bash
|
|
# Edit package.json, then rebuild:
|
|
nix build .
|
|
```
|
|
|
|
In case Nix complains about the hash, run this to get the correct one and replace in flake.nix:
|
|
|
|
```bash
|
|
nix run nixpkgs#prefetch-npm-deps -- package-lock.json
|
|
```
|