Skip to content

docs: Add running tasks guide#1626

Merged
acekyd merged 9 commits intomainfrom
docs/running-tasks
Mar 13, 2025
Merged

docs: Add running tasks guide#1626
acekyd merged 9 commits intomainfrom
docs/running-tasks

Conversation

@acekyd
Copy link
Copy Markdown
Contributor

@acekyd acekyd commented Mar 11, 2025

This pull request includes updates to the Goose CLI documentation to add new command options and provide detailed usage instructions.

Documentation updates:

@acekyd acekyd requested review from EbonyLouis and angiejones March 11, 2025 20:45
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 11, 2025

PR Preview Action v1.6.0

🚀 View preview at
https://block.github.io/goose/pr-preview/pr-1626/

Built to branch gh-pages at 2025-03-13 01:32 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

If you don't want Goose to exit at the end of the task, you can pass the `s` flag to start an interactive session after processing your initial commands:

```bash
goose run -i instructions.txt -s
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this a shortcut for goose run --interactive?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah yes it is.

```bash
# Use built-in extensions e.g developer and computercontroller extensions
goose run --with-builtin "developer,computercontroller" -t "your instructions"

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


```bash

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

making 2 separate code blocks so that either can be copied individually


For one-off commands, use the text option:
```bash
goose run -t "Generate a test plan for the login feature"
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this prints output then exits?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've updated to a better example. But yes, goose mostly prints what it's doing and then exits.

Copy link
Copy Markdown
Collaborator

@angiejones angiejones left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks great! few change requests

@acekyd acekyd requested a review from angiejones March 12, 2025 11:18
@acekyd acekyd merged commit 275adc3 into main Mar 13, 2025
4 checks passed
@acekyd acekyd deleted the docs/running-tasks branch March 13, 2025 11:46
michaelneale added a commit that referenced this pull request Mar 14, 2025
* main: (32 commits)
  ui: load builtins (#1679)
  chore(release): release version 1.0.14 (#1676)
  Revert "feat: handling larger more complex PDF docs (and fix) (#1663)" (#1675)
  fix: uvshim default to existing uv configuration (#1670)
  fix: handle interruptions during tool responses (#1651)
  feat: Copy error message button in toast (#1658)
  feat: handling larger more complex PDF docs (and fix) (#1663)
  Add Filesystem Tutorial (#1666)
  docs: figma blog post (#1647)
  docs: updating goose modes doc (#1665)
  docs: Add running tasks guide (#1626)
  docs: Add experimental features (#1644)
  feat(cli): add better error message, support stdin via -i - or just no args (#1660)
  feat: extensions read config (#1637)
  fix: trigger words for memory (#1654)
  fix: cleanup keyboard shortcut indication (#1642)
  Extensions load in background and show pending state (#1657)
  Extension error toast stays until dismissed, and error message cleanup (#1653)
  fix: remove other category in settings (#1641)
  fix: restore image outputs from tool calls (#1640)
  ...
kalvinnchau added a commit that referenced this pull request Mar 14, 2025
* origin/main: (29 commits)
  ui: reorganize extensions settings (#1702)
  feat: google_drive write tools and read comment tool (#1650)
  fix: developer builtin name (#1699)
  chore: update extensions section to work with new endpoints (#1696)
  chore: move things around (#1662)
  ui: extensions state updates (#1674)
  docs: goose ollama blog, updated (#1691)
  ui: load builtins (#1679)
  chore(release): release version 1.0.14 (#1676)
  Revert "feat: handling larger more complex PDF docs (and fix) (#1663)" (#1675)
  fix: uvshim default to existing uv configuration (#1670)
  fix: handle interruptions during tool responses (#1651)
  feat: Copy error message button in toast (#1658)
  feat: handling larger more complex PDF docs (and fix) (#1663)
  Add Filesystem Tutorial (#1666)
  docs: figma blog post (#1647)
  docs: updating goose modes doc (#1665)
  docs: Add running tasks guide (#1626)
  docs: Add experimental features (#1644)
  feat(cli): add better error message, support stdin via -i - or just no args (#1660)
  ...
laanak08 added a commit that referenced this pull request Mar 16, 2025
* main: (31 commits)
  feat: add default metrics for core evals (#1602)
  feat(google_drive): use oauth2 crate for PKCE support, make token storage generic over Serializable (#1645)
  ui: reorganize extensions settings (#1702)
  feat: google_drive write tools and read comment tool (#1650)
  fix: developer builtin name (#1699)
  chore: update extensions section to work with new endpoints (#1696)
  chore: move things around (#1662)
  ui: extensions state updates (#1674)
  docs: goose ollama blog, updated (#1691)
  ui: load builtins (#1679)
  chore(release): release version 1.0.14 (#1676)
  Revert "feat: handling larger more complex PDF docs (and fix) (#1663)" (#1675)
  fix: uvshim default to existing uv configuration (#1670)
  fix: handle interruptions during tool responses (#1651)
  feat: Copy error message button in toast (#1658)
  feat: handling larger more complex PDF docs (and fix) (#1663)
  Add Filesystem Tutorial (#1666)
  docs: figma blog post (#1647)
  docs: updating goose modes doc (#1665)
  docs: Add running tasks guide (#1626)
  ...
ahau-square pushed a commit that referenced this pull request May 2, 2025
cbruyndoncx pushed a commit to cbruyndoncx/goose that referenced this pull request Jul 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants