Skip to content

Commit efa5ce1

Browse files
m2declaude
andcommitted
Update README to document remote recipe fetching
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>
1 parent aceec72 commit efa5ce1

1 file changed

Lines changed: 18 additions & 10 deletions

File tree

README.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@
1212
# Install
1313
cargo install getapi
1414

15+
# Fetch the latest provider recipes
16+
getapi update
17+
1518
# Set up Twitter API credentials
1619
getapi twitter
1720

@@ -48,7 +51,7 @@ Prebuilt binaries for macOS, Linux, and Windows are available on the [GitHub Rel
4851

4952
## Providers
5053

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:
5255

5356
| Provider | Category | Estimated Time |
5457
|----------|----------|---------------|
@@ -88,10 +91,13 @@ getapi openai
8891
### Commands
8992

9093
```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)
95101
```
96102

97103
### Options
@@ -101,6 +107,7 @@ getapi status # Show active sessions
101107
--output-file <path> # Write credentials to a specific file
102108
--non-interactive # Print steps without prompts (for CI/docs)
103109
--recipe <path> # Use a custom recipe JSON file
110+
--recipe-dir <path> # Load recipes from a directory
104111
```
105112

106113
### Manifest file
@@ -122,18 +129,19 @@ getapi is designed to work well with AI coding agents:
122129

123130
- **`getapi <provider> --help`** shows the full setup flow without running it
124131
- **`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`
126133

127134
## Adding a Provider
128135

129136
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.
130137

131138
## How It Works
132139

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
137145

138146
## Licence
139147

0 commit comments

Comments
 (0)