aljaz/goose
1
0
Fork 0
mirror of https://github.com/aljazceru/goose.git synced 2025-12-17 22:24:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: elaborate on starting sessions with extensions (#1127)

Browse Source 
Co-authored-by: Angie Jones <angiej@3d634b34e22046c0bc99c9b37c6eede5.local>
This commit is contained in:
Angie Jones
2025-02-06 14:42:19 -06:00
committed by GitHub
parent 0869701643
commit ddb7cdb762
1 changed files with 41 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
documentation/docs/getting-started/using-extensions.md
View File

@@ -246,28 +246,59 @@ You can remove installed extensions.
## Starting a Session with Extensions ## Starting Session with Extensions
You can start a tailored goose session with specific extensions directly from the CLI. To do this, run the following command: You can start a tailored Goose session with specific extensions directly from the CLI. This will add and enable the extensions, so there's no need to do this if you already have the extensions enabled.
### Built-in Extensions
To enable a built-in extension while starting a session, run the following command:
```bash
goose session --with-builtin "{extension_id}"
```
For example, to enable the Developer and Computer Controller extensions and start a session, you'd run:
```bash
goose session --with-builtin "developer,computercontroller"
```
Or alternatively:
```bash
goose session --with-builtin developer --with-builtin computercontroller
```
### External Extensions
To enable an extension while starting a session, run the following command:
```bash ```bash
goose session --with-extension "{extension command}" --with-extension "{antoher extension command}" goose session --with-extension "{extension command}" --with-extension "{antoher extension command}"
``` ```
:::info For example, to start a session with the [Fetch extension](https://github.com/modelcontextprotocol/servers/tree/main/src/fetch), you'd run:
You may need to set necessary environment variables for the extension to work correctly.
```bash
goose session --with-extension "uvx mcp-server-fetch"
```
#### Environment Variables
Some extensions require environment variables. You can include these in your command:
```bash ```bash
goose session --with-extension "VAR=value command arg1 arg2" goose session --with-extension "VAR=value command arg1 arg2"
``` ```
:::
:::tip For example, to start a session with the [GitHub extension](https://github.com/modelcontextprotocol/servers/tree/main/src/github), you'd run:
You can also start a session with built-in extensions by using the `--with-builtin` flag.
```bash ```bash
goose session --with-builtin "developer,memory" goose session --with-extension "GITHUB_PERSONAL_ACCESS_TOKEN=<YOUR_TOKEN> npx -y @modelcontextprotocol/server-github"
goose session --with-builtin developer --with-builtin memory
``` ```
:::
## Developing Extensions ## Developing Extensions
Goose extensions are implemented with MCP, a standard protocol that allows AI models and agents to securely connect with local or remote resources. Learn how to build your own [extension as an MCP server](https://modelcontextprotocol.io/quickstart/server). Goose extensions are implemented with MCP, a standard protocol that allows AI models and agents to securely connect with local or remote resources. Learn how to build your own [extension as an MCP server](https://modelcontextprotocol.io/quickstart/server).