You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Reflects the two-layer recipe system introduced in v1.1.0: bundled
recipes work offline, and `getapi update` fetches the latest from
GitHub without reinstalling. Also adds missing commands (update,
validate, reset) and the --recipe-dir option.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: README.md
+18-10Lines changed: 18 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,6 +12,9 @@
12
12
# Install
13
13
cargo install getapi
14
14
15
+
# Fetch the latest provider recipes
16
+
getapi update
17
+
15
18
# Set up Twitter API credentials
16
19
getapi twitter
17
20
@@ -48,7 +51,7 @@ Prebuilt binaries for macOS, Linux, and Windows are available on the [GitHub Rel
48
51
49
52
## Providers
50
53
51
-
getapi ships with 20 built-in provider recipes:
54
+
getapi bundles 20 provider recipes for offline use. Run `getapi update` to fetch the latest recipes from the repository — new and updated providers are available without reinstalling:
52
55
53
56
| Provider | Category | Estimated Time |
54
57
|----------|----------|---------------|
@@ -88,10 +91,13 @@ getapi openai
88
91
### Commands
89
92
90
93
```sh
91
-
getapi <provider># Start guided setup for a provider
92
-
getapi list # List all available providers
93
-
getapi resume # Resume a paused setup session
94
-
getapi status # Show active sessions
94
+
getapi <provider># Start guided setup for a provider
95
+
getapi list # List all available providers
96
+
getapi update # Fetch the latest provider recipes
97
+
getapi resume <provider># Resume a paused setup session
98
+
getapi status # Show active sessions
99
+
getapi validate <p># Re-run credential validation
100
+
getapi reset [provider] # Clear session data (one provider or all)
95
101
```
96
102
97
103
### Options
@@ -101,6 +107,7 @@ getapi status # Show active sessions
101
107
--output-file <path># Write credentials to a specific file
102
108
--non-interactive # Print steps without prompts (for CI/docs)
103
109
--recipe <path># Use a custom recipe JSON file
110
+
--recipe-dir <path># Load recipes from a directory
104
111
```
105
112
106
113
### Manifest file
@@ -122,18 +129,19 @@ getapi is designed to work well with AI coding agents:
122
129
123
130
-**`getapi <provider> --help`** shows the full setup flow without running it
124
131
-**`getapi <provider> --non-interactive`** prints all steps as plain text, so an agent can relay instructions to a user or parse the credential requirements
125
-
- All provider recipes are JSON files in `providers/` and can be read directly
132
+
- All provider recipes are JSON files and can be read directly; bundled ones live in `providers/`, and fetched ones are cached locally after `getapi update`
126
133
127
134
## Adding a Provider
128
135
129
136
The most common contribution is adding a new provider recipe. See [CONTRIBUTING.md](CONTRIBUTING.md) for the recipe JSON structure, step types, and testing instructions.
130
137
131
138
## How It Works
132
139
133
-
1.**Recipe files** in `providers/` define the step-by-step flow for each service as JSON
134
-
2.**The runner** walks the user through each step: opening URLs, prompting for input, offering choices, and validating credentials
135
-
3.**Sessions** track progress so you can pause and resume long setup flows
136
-
4.**Output** writes collected credentials to `.env`, JSON, or YAML files
140
+
1.**Recipe files** define the step-by-step flow for each service as JSON
141
+
2.**Bundled recipes** are embedded in the binary and work offline; run `getapi update` to fetch the latest recipes from GitHub without reinstalling
142
+
3.**The runner** walks the user through each step: opening URLs, prompting for input, offering choices, and validating credentials
143
+
4.**Sessions** track progress so you can pause and resume long setup flows
144
+
5.**Output** writes collected credentials to `.env`, JSON, or YAML files
0 commit comments