@inference-gateway/cli 0.184.0 → 0.185.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +17 -13
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -276,13 +276,16 @@ go build -o infer.exe ./cmd/infer
|
|
|
276
276
|
|
|
277
277
|
## Quick Start
|
|
278
278
|
|
|
279
|
-
1. **Initialize
|
|
279
|
+
1. **Initialize the userspace baseline**:
|
|
280
280
|
|
|
281
281
|
```bash
|
|
282
282
|
infer init
|
|
283
283
|
```
|
|
284
284
|
|
|
285
|
-
This creates
|
|
285
|
+
This creates the shared `~/.infer/` configuration directory. All state
|
|
286
|
+
(conversations, logs, history, artifacts) lives under `~/.infer/` too; a
|
|
287
|
+
project `.infer/` is an optional config override layer you create with
|
|
288
|
+
`infer config set --project` when a project needs different settings.
|
|
286
289
|
|
|
287
290
|
2. **Set up your environment** (create `.env` file):
|
|
288
291
|
|
|
@@ -318,11 +321,11 @@ The CLI provides several commands for different workflows. For detailed document
|
|
|
318
321
|
|
|
319
322
|
### Core Commands
|
|
320
323
|
|
|
321
|
-
**`infer init`** - Initialize
|
|
324
|
+
**`infer init`** - Initialize the userspace baseline configuration
|
|
322
325
|
|
|
323
326
|
```bash
|
|
324
|
-
infer init #
|
|
325
|
-
infer init --
|
|
327
|
+
infer init # Seed the shared ~/.infer/ baseline
|
|
328
|
+
infer init --overwrite # Re-seed the baseline files
|
|
326
329
|
```
|
|
327
330
|
|
|
328
331
|
**`infer chat`** - Start an interactive chat session with model selection
|
|
@@ -385,8 +388,8 @@ infer config set tools.enabled true
|
|
|
385
388
|
infer config set tools.bash.enabled true
|
|
386
389
|
infer config set tools.safety.require_approval true
|
|
387
390
|
|
|
388
|
-
# Write
|
|
389
|
-
infer config set agent.model "openai/gpt-4o" --
|
|
391
|
+
# Write a project-level override into ./.infer/config.yaml instead
|
|
392
|
+
infer config set agent.model "openai/gpt-4o" --project
|
|
390
393
|
```
|
|
391
394
|
|
|
392
395
|
> System prompts live in `prompts.yaml` (e.g. `prompts.agent.system_prompt`), not
|
|
@@ -464,7 +467,7 @@ See [docs/plugins.md](docs/plugins.md) for the mapping and security model.
|
|
|
464
467
|
|
|
465
468
|
```bash
|
|
466
469
|
infer conversations list # Find the session ID
|
|
467
|
-
infer export <session-id> # Writes
|
|
470
|
+
infer export <session-id> # Writes ~/.infer/projects/<slug>/exports/chat_export_<timestamp>.md
|
|
468
471
|
```
|
|
469
472
|
|
|
470
473
|
**`infer version`** - Display CLI version information
|
|
@@ -551,7 +554,7 @@ use the `gh` CLI through Bash (or the built-in `/scm` shortcuts) for GitHub oper
|
|
|
551
554
|
|
|
552
555
|
| Tool | Purpose | Approval | Enabled by |
|
|
553
556
|
| ------ | --------- | ---------- | ------------ |
|
|
554
|
-
| **ImageGeneration** | Generate an image from a prompt into
|
|
557
|
+
| **ImageGeneration** | Generate an image from a prompt into `~/.infer/projects/<project-slug>/artifacts/` | No | `tools.image_generation.enabled` |
|
|
555
558
|
| **ImageEdit** | Edit an existing image and save the result | No | `tools.image_edit.enabled` |
|
|
556
559
|
| **ImageVariation** | Produce a variation of an existing image | No | `tools.image_variation.enabled` |
|
|
557
560
|
| **TextToSpeech** | Synthesize speech to a WAV locally, optionally cloning a voice | No | `text_to_speech.enabled` |
|
|
@@ -840,7 +843,7 @@ approval**; override per tool with `tools.<name>.require_approval`.
|
|
|
840
843
|
| Wait | No | Passive utility - blocks until condition met, no side effects |
|
|
841
844
|
| Read, Grep, Tree | No | Read-only operations |
|
|
842
845
|
| Memory, TodoWrite | No | Local agent state (explicitly exempt) |
|
|
843
|
-
| Image tools | No | Output confined to
|
|
846
|
+
| Image tools | No | Output confined to `~/.infer/projects/<project-slug>/artifacts/` - override with `tools.<name>.require_approval` |
|
|
844
847
|
| TextToSpeech | No | Output confined to `text_to_speech.output_dir` - override with `text_to_speech.require_approval` |
|
|
845
848
|
| Computer-use tools | No | Run silently in the background |
|
|
846
849
|
| A2A_QueryAgent, A2A_QueryTask | No | Read-only A2A queries |
|
|
@@ -941,7 +944,7 @@ actions.
|
|
|
941
944
|
Create shortcuts that use LLMs to transform data:
|
|
942
945
|
|
|
943
946
|
```yaml
|
|
944
|
-
#
|
|
947
|
+
# ~/.infer/shortcuts/custom-example.yaml
|
|
945
948
|
shortcuts:
|
|
946
949
|
- name: analyze-diff
|
|
947
950
|
description: "Analyze git diff with AI"
|
|
@@ -964,10 +967,11 @@ shortcuts:
|
|
|
964
967
|
|
|
965
968
|
### Custom Shortcuts
|
|
966
969
|
|
|
967
|
-
Create custom shortcuts by adding YAML files to
|
|
970
|
+
Create custom shortcuts by adding YAML files to `~/.infer/shortcuts/` (a
|
|
971
|
+
project `./.infer/shortcuts/` is overlaid on top by name):
|
|
968
972
|
|
|
969
973
|
```yaml
|
|
970
|
-
#
|
|
974
|
+
# ~/.infer/shortcuts/custom-dev.yaml
|
|
971
975
|
shortcuts:
|
|
972
976
|
- name: tests
|
|
973
977
|
description: "Run all tests"
|