docs: goose recipe open command (#5264)
This commit is contained in:
@@ -267,11 +267,12 @@ goose bench ...etc.
|
|||||||
---
|
---
|
||||||
|
|
||||||
#### recipe
|
#### recipe
|
||||||
Used to validate recipe files and manage recipe sharing.
|
Used to validate recipe files, manage recipe sharing, and open recipes in goose desktop.
|
||||||
|
|
||||||
**Commands:**
|
**Commands:**
|
||||||
- `validate <FILE>`: Validate a recipe file
|
- `validate <FILE>`: Validate a recipe file
|
||||||
- `deeplink <FILE>`: Generate a shareable link for a recipe file
|
- `deeplink <FILE>`: Generate a shareable link for a recipe file
|
||||||
|
- `open <FILE>`: Open a recipe file directly in goose desktop
|
||||||
|
|
||||||
**Usage:**
|
**Usage:**
|
||||||
```bash
|
```bash
|
||||||
@@ -283,6 +284,12 @@ goose recipe validate my-recipe.yaml
|
|||||||
# Generate a shareable link
|
# Generate a shareable link
|
||||||
goose recipe deeplink my-recipe.yaml
|
goose recipe deeplink my-recipe.yaml
|
||||||
|
|
||||||
|
# Open a recipe in goose desktop
|
||||||
|
goose recipe open my-recipe.yaml
|
||||||
|
|
||||||
|
# Open a recipe by name
|
||||||
|
goose recipe open my-recipe
|
||||||
|
|
||||||
# Get help about recipe commands
|
# Get help about recipe commands
|
||||||
goose recipe help
|
goose recipe help
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ Files should be named either:
|
|||||||
- `recipe.yaml`/`recipe.json`
|
- `recipe.yaml`/`recipe.json`
|
||||||
- `<recipe_name>.yaml`/`<recipe_name>.json`
|
- `<recipe_name>.yaml`/`<recipe_name>.json`
|
||||||
|
|
||||||
After creating recipe files, you can use [`goose` CLI commands](/docs/guides/goose-cli-commands) to run or validate the files and to manage recipe sharing.
|
After creating recipe files, you can use the [`goose recipe` subcommands](/docs/guides/goose-cli-commands#recipe) to validate, share, and open your recipes.
|
||||||
|
|
||||||
### CLI and Desktop Formats
|
### CLI and Desktop Formats
|
||||||
|
|
||||||
|
|||||||
@@ -487,7 +487,7 @@ When someone clicks the link, it will open Goose Desktop with your recipe config
|
|||||||
You can share a recipe with Desktop or CLI users by sending the recipe file directly.
|
You can share a recipe with Desktop or CLI users by sending the recipe file directly.
|
||||||
|
|
||||||
- Desktop users can [import the recipe](/docs/guides/recipes/storing-recipes#importing-recipes) (YAML only).
|
- Desktop users can [import the recipe](/docs/guides/recipes/storing-recipes#importing-recipes) (YAML only).
|
||||||
- CLI users can run a YAML or JSON recipe using `goose run --recipe <FILE>`
|
- CLI users can run a YAML or JSON recipe using `goose run --recipe <FILE>` or open it directly in goose desktop with `goose recipe open <FILE>`. See the [CLI Commands guide](/docs/guides/goose-cli-commands#recipe) for details.
|
||||||
|
|
||||||
## Schedule Recipe
|
## Schedule Recipe
|
||||||
<Tabs groupId="interface">
|
<Tabs groupId="interface">
|
||||||
|
|||||||
@@ -151,7 +151,7 @@ Set up [custom recipe paths](/docs/guides/recipes/session-recipes#configure-reci
|
|||||||
</TabItem>
|
</TabItem>
|
||||||
<TabItem value="cli" label="Goose CLI">
|
<TabItem value="cli" label="Goose CLI">
|
||||||
|
|
||||||
Once you've located your recipe file, [run the recipe](/docs/guides/recipes/session-recipes#run-a-recipe).
|
Once you've located your recipe file, [run the recipe](/docs/guides/recipes/session-recipes#run-a-recipe) or [open it in goose desktop](/docs/guides/goose-cli-commands#recipe).
|
||||||
|
|
||||||
:::tip Format Compatibility
|
:::tip Format Compatibility
|
||||||
The CLI can run recipes saved from Goose Desktop without any conversion. Both CLI-created and Desktop-saved recipes work with all recipe commands.
|
The CLI can run recipes saved from Goose Desktop without any conversion. Both CLI-created and Desktop-saved recipes work with all recipe commands.
|
||||||
|
|||||||
Reference in New Issue
Block a user