Skip to content

Commit 8629fc4

Browse files
committed
chore: update doc
1 parent 56e01f9 commit 8629fc4

2 files changed

Lines changed: 133 additions & 2 deletions

File tree

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1-
# json-cli
1+
# @ekaone/json-cli
2+
3+
AI-powered CLI task runner. Just write in plain English, AI generates a validated JSON command plan, and the runner executes it step by step.
4+
5+
## Think safety first
6+
> For safety, `json-cli` will generate the plan and ask for confirmation before running the steps. You can also use the `--dry-run` flag to preview the plan without executing it.
27
3-
AI-powered CLI task runner. Write in plain English, AI generates a validated JSON command plan and finally runner executes it step by step.
48

59
## Installation
610

@@ -99,6 +103,10 @@ json-cli "run tests, check git diff, then git add and commit with message 'fix:
99103
json-cli "install deps, run typecheck, run tests, build, git add, commit with message 'ci: local pipeline passed', push"
100104
```
101105

106+
### More examples
107+
108+
💡 There are a lot cool examples in the [examples](./examples/README.md) file.
109+
102110
### Options
103111

104112
```bash

examples/README.md

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
## Shell Examples
2+
3+
```bash
4+
json-cli "list files in current directory"
5+
```
6+
7+
```bash
8+
json-cli "Find child processes in the 3000–4000 range in Git Bash"
9+
```
10+
11+
```bash
12+
json-cli "Check disk usage and show top 10 largest files in current directory"
13+
```
14+
15+
```bash
16+
json-cli "Kill all processes using port 3000"
17+
```
18+
19+
```bash
20+
json-cli "Find all JavaScript files modified in the last 7 days"
21+
```
22+
23+
```bash
24+
json-cli "Compress all log files older than 30 days into a tar.gz archive"
25+
```
26+
27+
## Docker Examples
28+
29+
```bash
30+
json-cli "Build a Docker image from the current directory and run it"
31+
```
32+
33+
```bash
34+
json-cli "Pull nginx image, run a container, and show running containers"
35+
```
36+
37+
```bash
38+
json-cli "Stop all running containers and remove them"
39+
```
40+
41+
```bash
42+
json-cli "Show all containers, their logs, and remove stopped containers"
43+
```
44+
45+
```bash
46+
json-cli "Build image from Dockerfile, tag it, and push to registry"
47+
```
48+
49+
```bash
50+
json-cli "Execute command in running container and show the output"
51+
```
52+
53+
```bash
54+
json-cli "Clean up: remove all stopped containers and unused images"
55+
```
56+
57+
```bash
58+
json-cli "Pull latest image, stop existing container, and restart with new image"
59+
```
60+
61+
```bash
62+
json-cli "Show running containers, check their resource usage, and display logs"
63+
```
64+
65+
## File System Examples
66+
67+
```bash
68+
json-cli "list files in current directory"
69+
```
70+
71+
```bash
72+
json-cli "Create a new directory called 'project' and navigate into it"
73+
```
74+
75+
```bash
76+
json-cli "Create multiple nested directories: src/components/ui"
77+
```
78+
79+
```bash
80+
json-cli "Copy all JavaScript files from src to dist directory"
81+
```
82+
83+
```bash
84+
json-cli "Move all log files to logs directory and rename them with timestamp"
85+
```
86+
87+
```bash
88+
json-cli "Create empty files: index.js, styles.css, README.md"
89+
```
90+
91+
```bash
92+
json-cli "Read package.json and display its contents"
93+
```
94+
95+
```bash
96+
json-cli "Remove all temporary files and clean up node_modules"
97+
```
98+
99+
```bash
100+
json-cli "Backup important files by copying them to backup directory"
101+
```
102+
103+
```bash
104+
json-cli "Create project structure with folders: src, tests, docs, build"
105+
```
106+
107+
## Git Examples
108+
109+
```bash
110+
json-cli "Check git status"
111+
```
112+
113+
```bash
114+
json-cli "Add all files, commit with message 'feat: add multi-intent support', then push"
115+
```
116+
117+
```bash
118+
json-cli "Run tests, check git diff, then git add and commit with message 'fix: catalog types'"
119+
```
120+
121+
```bash
122+
json-cli "Install deps, run typecheck, run tests, build, git add, commit with message 'ci: local pipeline passed', push"
123+
```

0 commit comments

Comments
 (0)