Skip to content

Commit 9c0f017

Browse files
authored
docs: list commands (#15)
1 parent 34f0382 commit 9c0f017

File tree

1 file changed

+71
-0
lines changed

1 file changed

+71
-0
lines changed

README.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,77 @@ visionboard
5050

5151
This will display the help information with available commands.
5252

53+
## Commands
54+
55+
### General Commands
56+
57+
```bash
58+
# Show version information
59+
visionboard version
60+
61+
# Check compatibility and availability with the API
62+
visionboard doctor
63+
```
64+
65+
### Bulk Import Management
66+
67+
```bash
68+
# List all available bulk import operations
69+
visionboard bulk-import list
70+
71+
# Run a bulk import operation
72+
visionboard bulk-import run -i <id> [-d <data> | -f <file>]
73+
```
74+
75+
Options for `bulk-import run`:
76+
- `-i, --id <id>`: Bulk import operation ID (required)
77+
- `-d, --data <data>`: JSON data to pass to the bulk import operation
78+
- `-f, --file <file>`: File containing JSON data to be parsed
79+
80+
**Note**: Exactly one of `-d` or `-f` must be provided.
81+
82+
### Workflow Management
83+
84+
```bash
85+
# List all available compliance workflows
86+
visionboard workflow list
87+
88+
# Execute a compliance workflow
89+
visionboard workflow execute -w <workflowName> [-d <data> | -f <file>]
90+
```
91+
92+
Options for `workflow execute`:
93+
- `-w, --workflow <workflowName>`: Workflow name (required)
94+
- `-d, --data <data>`: JSON data to pass to the workflow
95+
- `-f, --file <file>`: File containing JSON data to be parsed
96+
97+
**Note**: Exactly one of `-d` or `-f` must be provided if the workflow requires additional data.
98+
99+
### Compliance Checklist Management
100+
101+
```bash
102+
# List all available compliance checklists
103+
visionboard compliance-checklist list
104+
```
105+
106+
### Compliance Check Management
107+
108+
```bash
109+
# List all available compliance checks
110+
visionboard compliance-check list
111+
```
112+
113+
### Project Management
114+
115+
```bash
116+
# Add a project with optional GitHub organizations
117+
visionboard project add -n <name> [-g | --github-orgs <githubOrgUrls...>]
118+
```
119+
120+
Options for `project add`:
121+
- `-n, --name <name>`: Project name (required)
122+
- `-g, --github-orgs <githubOrgUrls...>`: GitHub organization URLs (optional)
123+
53124
## Configuration
54125

55126
The visionBoard CLI supports configuration through environment variables:

0 commit comments

Comments
 (0)