initial commit
This commit is contained in:
commit
db4a1e24ca
10 changed files with 1977 additions and 0 deletions
47
README.md
Normal file
47
README.md
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
# 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.js --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 from `name-placeholder` to your desired name:
|
||||
|
||||
```bash
|
||||
sed -i 's/name-placeholder/your-new-name/g' package.json src/index.ts flake.nix
|
||||
```
|
||||
|
||||
Then rebuild:
|
||||
|
||||
```bash
|
||||
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
|
||||
```
|
||||
Loading…
Add table
Add a link
Reference in a new issue