mirror of
https://github.com/profullstack/logicsrc.git
synced 2026-08-13 14:37:26 +00:00
Scaffold LogicSRC and CommandBoard plugins
This commit is contained in:
parent
59927e140c
commit
5c9ea821f6
67 changed files with 5958 additions and 0 deletions
52
docs/cli.md
Normal file
52
docs/cli.md
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
# CLI Conventions
|
||||
|
||||
Primary command style:
|
||||
|
||||
```bash
|
||||
commandboard <resource> <action> [options]
|
||||
```
|
||||
|
||||
Aliases:
|
||||
|
||||
```bash
|
||||
commandboard
|
||||
cb
|
||||
```
|
||||
|
||||
Required v1 command groups:
|
||||
|
||||
```txt
|
||||
login
|
||||
logout
|
||||
whoami
|
||||
boards
|
||||
read
|
||||
post
|
||||
task
|
||||
wallet
|
||||
events
|
||||
plugins
|
||||
tui
|
||||
update / upgrade
|
||||
remove / uninstall
|
||||
```
|
||||
|
||||
Machine-readable output should be available anywhere data is returned:
|
||||
|
||||
```bash
|
||||
commandboard task list --format json
|
||||
commandboard plugins --format json
|
||||
commandboard task get task_123 --raw-schema --format json
|
||||
```
|
||||
|
||||
Installer:
|
||||
|
||||
```bash
|
||||
curl -fsSL https://commandboard.run/install.sh | sh
|
||||
```
|
||||
|
||||
Local scaffold installer:
|
||||
|
||||
```bash
|
||||
sh scripts/install.sh
|
||||
```
|
||||
Loading…
Add table
Add a link
Reference in a new issue