docs: lowercase goose in getting-started and guides topics (#5857)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
@@ -4,20 +4,20 @@ title: Running Tasks
|
||||
sidebar_label: Run Tasks
|
||||
---
|
||||
|
||||
When working with the Goose CLI, you can pass files and instructions to the `goose run` command to execute tasks and workflows. This could be a simple one-liner command or a complex set of instructions stored in a file.
|
||||
When working with the goose CLI, you can pass files and instructions to the `goose run` command to execute tasks and workflows. This could be a simple one-liner command or a complex set of instructions stored in a file.
|
||||
|
||||
## Basic Usage
|
||||
|
||||
The `goose run` command starts a new session, begins executing using any arguments provided and exits the session automatically once the task is complete.
|
||||
|
||||
There are multiple ways to run tasks with Goose; check out the [list of options](/docs/guides/goose-cli-commands.md#run-options).
|
||||
There are multiple ways to run tasks with goose; check out the [list of options](/docs/guides/goose-cli-commands.md#run-options).
|
||||
|
||||
### Text in the command
|
||||
```bash
|
||||
goose run -t "your instructions here"
|
||||
```
|
||||
|
||||
Using the `-t` flag, one is able to pass a text instruction directly to the command. This is great for quick, one-off commands where you do not need an interactive session with Goose. The instructions will be executed, and the session will end. An example usage could be using in a CI/CD pipeline or running alongside other scripts.
|
||||
Using the `-t` flag, one is able to pass a text instruction directly to the command. This is great for quick, one-off commands where you do not need an interactive session with goose. The instructions will be executed, and the session will end. An example usage could be using in a CI/CD pipeline or running alongside other scripts.
|
||||
|
||||
### Using an instruction file
|
||||
If you have a complex set of instructions or a workflow that you want to automate, you can store them in a file and pass it to the `goose run` command:
|
||||
@@ -50,7 +50,7 @@ Save findings in 'security_audit.md' with severity levels highlighted.
|
||||
```
|
||||
|
||||
### With stdin
|
||||
You can also pass instructions to Goose using standard input via `-i -`. This is useful when you want to pipe commands from another tool or script into Goose.
|
||||
You can also pass instructions to goose using standard input via `-i -`. This is useful when you want to pipe commands from another tool or script into goose.
|
||||
|
||||
#### Simple echo pipe
|
||||
|
||||
@@ -71,13 +71,13 @@ EOF
|
||||
|
||||
### Interactive Mode
|
||||
|
||||
If you don't want Goose to exit at the end of the task, you can pass the `-s` or `--interactive` flag to start an interactive session after processing your initial commands:
|
||||
If you don't want goose to exit at the end of the task, you can pass the `-s` or `--interactive` flag to start an interactive session after processing your initial commands:
|
||||
|
||||
```bash
|
||||
goose run -i instructions.txt -s
|
||||
```
|
||||
|
||||
This is useful when you want to continue working with Goose after your initial commands are processed.
|
||||
This is useful when you want to continue working with goose after your initial commands are processed.
|
||||
|
||||
### Session Management
|
||||
|
||||
@@ -98,7 +98,7 @@ You can also run commands without creating or storing a session file by using th
|
||||
goose run --no-session -t "your command here"
|
||||
```
|
||||
### Set Provider and Model
|
||||
You can run Goose sessions with a specific provider and model, which overrides the provider and model settings in your [environment variables](/docs/guides/environment-variables.md).
|
||||
You can run goose sessions with a specific provider and model, which overrides the provider and model settings in your [environment variables](/docs/guides/environment-variables.md).
|
||||
|
||||
```bash
|
||||
goose run --provider anthropic --model claude-4-sonnet -t "initial prompt"
|
||||
|
||||
Reference in New Issue
Block a user