Skip to content

Commit 5a5e7a1

Browse files
committed
chore: update doc
1 parent cd46e6c commit 5a5e7a1

File tree

2 files changed

+34
-27
lines changed

2 files changed

+34
-27
lines changed

.env.example

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# API Keys for AI Providers
2+
ANTHROPIC_API_KEY=your_api_key
3+
OPENAI_API_KEY=your_api_key
4+
5+
# Ollama Configuration (optional - defaults shown)
6+
OLLAMA_BASE_URL=http://localhost:11434
7+
OLLAMA_MODEL=llama3.2

README.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# json-cli
22

3-
AI-powered CLI task runner. Describe your goal in plain EnglishAI generates a validated JSON command plan runner executes it step by step.
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.
44

55
## Installation
66

@@ -107,31 +107,31 @@ json-cli
107107
json-cli --help
108108
```
109109
```
110-
json-cli — AI-powered CLI task runner
111-
112-
Usage
113-
json-cli "<your goal>" [options]
114-
115-
Options
116-
--provider <name> AI provider: claude | openai | ollama (default: claude)
117-
--yes Skip confirmation prompt
118-
--dry-run Show plan without executing
119-
--debug Show system prompt and raw AI response
120-
--help Show this help message
121-
--version, -v Show version
122-
123-
Examples
124-
json-cli "please run tests"
125-
json-cli "run tests and build"
126-
json-cli "run tests and build" --yes
127-
json-cli "git add, commit with message 'fix: bug', push"
128-
json-cli "clone https://github.com/user/repo, install deps, run dev"
129-
json-cli "run tests and publish" --provider openai
130-
json-cli "run tests" --dry-run
131-
json-cli "run tests" --debug
132-
json-cli "run tests" --debug --dry-run
133-
134-
Docs: https://github.com/ekaone/json-cli
110+
json-cli — AI-powered CLI task runner
111+
112+
Usage
113+
json-cli "<your goal>" [options]
114+
115+
Options
116+
--provider <name> AI provider: claude | openai | ollama (default: claude)
117+
--yes Skip confirmation prompt
118+
--dry-run Show plan without executing
119+
--debug Show system prompt and raw AI response
120+
--help Show this help message
121+
--version, -v Show version
122+
123+
Examples
124+
json-cli "please run tests"
125+
json-cli "run tests and build"
126+
json-cli "run tests and build" --yes
127+
json-cli "git add, commit with message 'fix: bug', push"
128+
json-cli "clone https://github.com/user/repo, install deps, run dev"
129+
json-cli "run tests and publish" --provider openai
130+
json-cli "run tests" --dry-run
131+
json-cli "run tests" --debug
132+
json-cli "run tests" --debug --dry-run
133+
134+
Docs: https://github.com/ekaone/json-cli
135135
```
136136

137137
---
@@ -172,7 +172,7 @@ Runner ← executes step by step, streams output live
172172
| `fs` | mkdir, touch, cp, mv, ls `(coming soon)` |
173173
| `shell` | any *(escape hatch — always requires extra confirmation)* |
174174

175-
> **Note:** Flags and arguments are unrestricted `--port 5000`, `-m "message"`, `--force` etc. are all passed freely. Only the command itself is whitelisted.
175+
> **Note:** Flags and arguments are unrestricted, `--port 5000`, `-m "message"`, `--force` etc. are all passed freely. Only the command itself is whitelisted.
176176
177177
---
178178

0 commit comments

Comments
 (0)