Skip to content

feat: add sidc-kit CLI #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
the-Drunken-coder merged 2 commits into from
Jun 26, 2026
Merged

feat: add sidc-kit CLI #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e5679df
feat: add sidc-kit CLI
the-Drunken-coder Jun 25, 2026
dd979ce
fix: harden CLI argument handling
the-Drunken-coder Jun 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,20 @@ npm test

## Usage

### CLI

```sh
sidc-kit search "friendly infantry" --limit 3
sidc-kit search "friendly infantry" --json
sidc-kit explain 130310001412110000000000000000 --json
sidc-kit build --affiliation friend --domain land --entity infantry --echelon platoon
sidc-kit render 130310001412110000000000000000 --size 40 > symbol.svg
```

The CLI wraps the public API without a separate data model. Human defaults use plain text, while `--json` returns JSON for commands and typed JSON errors on stderr. Render size must be between 1 and 4096 pixels.

### TypeScript

```ts
import { buildSidc, explainSidc, renderSymbol, searchSymbols } from "sidc-kit";

Expand Down
18 changes: 18 additions & 0 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 6 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
"type": "module",
"main": "./dist/index.js",
"types": "./dist/index.d.ts",
"bin": {
"sidc-kit": "./dist/cli.js"
},
"exports": {
".": {
"types": "./dist/index.d.ts",
Expand All @@ -14,7 +17,8 @@
"files": [
"dist",
"README.md",
"CHANGELOG.md"
"CHANGELOG.md",
"LICENSE"
],
"repository": {
"type": "git",
Expand Down Expand Up @@ -44,6 +48,7 @@
"milsymbol": "^3.0.4"
},
"devDependencies": {
"@types/node": "^20.19.43",
"typescript": "^5.9.3"
},
"engines": {
Expand Down
Loading
Loading