Skip to content

docs: add stdin #1769

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
acekyd merged 2 commits into from
Mar 19, 2025
+20 −1
Merged

docs: add stdin #1769

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
72d1316
add stdin guide
acekyd Mar 19, 2025
9619803
fix github workflow
acekyd Mar 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/deploy-docs-and-extensions.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ jobs:
mkdir combined-build
cp -r documentation/build/* combined-build/
mkdir -p combined-build/v1/extensions
mkdir -p combined-build/v1/extensions/install-link-generator
cp -r extensions-site/build/client/* combined-build/v1/extensions/
cp -r extensions-site/install-link-generator/* combined-build/v1/extensions/install-link-generator/

Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/guides/goose-cli-commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ Execute commands from an instruction file or stdin. Check out the [full guide](/

**Options:**

- **`-i, --instructions <FILE>`**: Path to instruction file containing commands
- **`-i, --instructions <FILE>`**: Path to instruction file containing commands. Use - for stdin.
- **`-t, --text <TEXT>`**: Input text to provide to Goose directly
- **`-s, --interactive`**: Continue in interactive mode after processing initial input
- **`-n, --name <NAME>`**: Name for this run session (e.g. 'daily-tasks')
Expand Down
18 changes: 18 additions & 0 deletions documentation/docs/guides/running-tasks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,24 @@ Here's an example of an instruction file that runs a security audit on project d
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.

#### Simple echo pipe

```bash
echo "What is 2+2?" | goose run -i -
```

#### Multi-line instructions
```bash
cat << EOF | goose run -i -
Please help me with these tasks:
1. Calculate 15% of 85
2. Convert 32°C to Fahrenheit
EOF
```

## Key Features

### Interactive Mode
Expand Down
Loading