docs: White label guide by maniksurtani · Pull Request #6857 · block/goose

maniksurtani · 2026-01-31T02:01:18Z

Summary

Type of Change

AI Assistance

This PR was created or reviewed with AI assistance

Copilot

Pull request overview

Adds a comprehensive white-labeling guide to help organizations create custom distributions of goose (preconfigured providers, extensions, branding, and custom UIs).

Changes:

Introduces a new WHITE_LABEL.md guide covering architecture, customization points, and multiple distribution scenarios.
Documents configuration, extension bundling, ACP/REST integration options, and recipe-based workflows.

Copilot · 2026-01-31T02:06:02Z

WHITE_LABEL.md

+# White-Labeling Goose
+
+This guide explains how to create custom distributions of goose tailored to your organization's needs—whether that's preconfigured models, custom tools, branded interfaces, or entirely new user experiences.
+
+## Overview
+
+Goose's architecture is designed for extensibility. Organizations can create "remixed" versions that:


This doc mixes "Goose"/"Goose's" with "goose", but the repo consistently uses the lowercase product name in top-level docs (e.g., README.md:3, BUILDING_LINUX.md:1); please standardize references to the project name to avoid inconsistent branding/searchability.

goose (lowercase) please

Copilot · 2026-01-31T02:06:03Z

WHITE_LABEL.md

+### Technical Details
+
+- Electron config: `ui/desktop/forge.config.ts`
+- UI components: `ui/desktop/src/renderer/` (if using standard structure)


ui/desktop/src/renderer/ is referenced here, but that directory doesn't exist in this repo (the entry point is ui/desktop/src/renderer.tsx); please update the path(s) so readers can actually find the UI code.

Suggested change

- UI components: `ui/desktop/src/renderer/` (if using standard structure)

- UI entry point: `ui/desktop/src/renderer.tsx`

katzdave · 2026-02-06T16:28:03Z

@block/goose-devrel do you think worth having here in the main repo? Or do we have similar info in the goose docs?

angiejones · 2026-02-06T16:48:45Z

WHITE_LABEL.md

@@ -0,0 +1,804 @@
+# White-Labeling Goose


white labeling doesn't seem like the right term for open source projects. how about using "Custom Distributions"?

angiejones · 2026-02-06T16:49:33Z

WHITE_LABEL.md

@@ -0,0 +1,804 @@
+# White-Labeling Goose


do you think this would be best as a top level file in the repo (as you have it now) or a guide on the doc site (with the readme pointing to this link)?

decided to keep top level, but have a doc refer to it (maximum discovery for developers - who it is for. Documentation is just for discovery when people don't browse via the repo, but the real word is in the repo md)

angiejones · 2026-02-06T16:52:28Z

@block/goose-devrel do you think worth having here in the main repo? Or do we have similar info in the goose docs?

ha, i had the same thought. i think a doc is better, and the README can point to it

michaelneale

I think worthwhile having - @angiejones yeah in 2 minds on white labelling - can be called "making a goose distro" - either distro... or white label seems to be a term of art but don't have strong opinion.

would be good to have this at top level but also linked from README IMO - as it is an important thing to encourage and I didn't realise how doable all this was already!)

maniksurtani · 2026-02-09T02:24:17Z

How about this:

We move this content to the docs site
We point to it from README.md
We still keep this file (WHITE_LABEL.md -- or better, call it CUSTOM_DISTROS.md) which also links to the docs site, just so we have that added top-level visibility.

WDYT @angiejones @michaelneale?

* main: (125 commits) chore: add a new scenario (#7107) fix: Goose Desktop missing Calendar and Reminders entitlements (#7100) Fix 'Edit In Place' and 'Fork Session' features (#6970) Fix: Only send command content to command injection classifier (excluding part of tool call dict) (#7082) Docs: require auth optional for custom providers (#7098) fix: improve text-muted contrast for better readability (#7095) Always sync bundled extensions (#7057) feat: Add tom (Top Of Mind) platform extension (#7073) chore(docs): update GOOSE_SESSION_ID -> AGENT_SESSION_ID (#6669) fix(ci): switch from cargo-audit to cargo-deny for advisory scanning (#7032) chore(deps): bump @isaacs/brace-expansion from 5.0.0 to 5.0.1 in /evals/open-model-gym/suite (#7085) chore(deps): bump @modelcontextprotocol/sdk from 1.25.3 to 1.26.0 in /evals/open-model-gym/mcp-harness (#7086) fix: switch to windows msvc (#7080) fix: allow unlisted models for CLI providers (#7090) Use goose port (#7089) chore: strip posthog for sessions/models/daily only (#7079) tidy: clean up old benchmark and add gym (#7081) fix: use command.process_group(0) for CLI providers, not just MCP (#7083) added build notify (#6891) test(mcp): add image tool test and consolidate MCP test fixtures (#7019) ...

michaelneale · 2026-02-10T02:38:36Z

ok, made some docs, and tidied up, moved it to distros md (I think .md makes sense - as it is a dev time activity - and want people to discover it even as they browse - added a link from readme too) doc is just to help highlight it.

cc @angiejones for your consideration

github-actions · 2026-02-10T02:40:01Z

PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-02-12 02:52 UTC

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.

Copilot · 2026-02-12T02:44:27Z

CUSTOM_DISTROS.md

+| `session/prompt` | Send a prompt and receive streaming responses |
+| `session/cancel` | Cancel an in-progress prompt |
+
+**Example: Python ACP client** (see `test_acp_client.py` for a complete example):


This references test_acp_client.py, but there is no such file in the repo; please link to an existing example or remove the reference to avoid sending readers on a dead end.

Suggested change

**Example: Python ACP client** (see `test_acp_client.py` for a complete example):

**Example: Python ACP client** (simplified, self-contained example):

Copilot · 2026-02-12T02:44:27Z

CUSTOM_DISTROS.md

+
+# Initialize and create session
+client = AcpClient()
+client.send_request("initialize", {"protocolVersion": "2025-01-01"})


Hardcoding protocolVersion: "2025-01-01" is likely incorrect (the Rust implementation/tests use sacp::schema::ProtocolVersion::LATEST); consider removing the literal date or documenting the currently supported ACP protocol version(s) so the example stays valid.

Suggested change

client.send_request("initialize", {"protocolVersion": "2025-01-01"})

client.send_request("initialize")

Copilot · 2026-02-12T02:44:28Z

CUSTOM_DISTROS.md

+3. Register in `crates/goose/src/providers/factory.rs`
+
+### Technical Details
+
+- Declarative providers: `crates/goose/src/config/declarative_providers.rs`
+- Provider trait: `crates/goose/src/providers/base.rs`
+- Provider registration: `crates/goose/src/providers/factory.rs`


crates/goose/src/providers/factory.rs is referenced here but does not exist; provider registration currently lives in crates/goose/src/providers/init.rs / the ProviderRegistry, so the path in this step should be corrected.

Suggested change

3. Register in `crates/goose/src/providers/factory.rs`

### Technical Details

- Declarative providers: `crates/goose/src/config/declarative_providers.rs`

- Provider trait: `crates/goose/src/providers/base.rs`

- Provider registration: `crates/goose/src/providers/factory.rs`

3. Register it in the `ProviderRegistry` in `crates/goose/src/providers/init.rs`

### Technical Details

- Declarative providers: `crates/goose/src/config/declarative_providers.rs`

- Provider trait: `crates/goose/src/providers/base.rs`

- Provider registration: `crates/goose/src/providers/init.rs` (via the `ProviderRegistry`)

Copilot · 2026-02-12T02:44:28Z

CUSTOM_DISTROS.md

+- ACP server implementation: `crates/goose-acp/src/server.rs`
+- CLI integration: `crates/goose-cli/src/cli.rs` (Command::Acp)
+- Protocol library: `sacp` crate (Rust implementation of ACP)
+- Test client example: `test_acp_client.py`


This is another reference to test_acp_client.py, which doesn’t exist in the repo; please remove or replace with a valid link/path.

Suggested change

- Test client example: `test_acp_client.py`

- Test client example: see ACP documentation linked above

Copilot · 2026-02-12T02:44:28Z

CUSTOM_DISTROS.md

+goose is licensed under Apache License 2.0 (ASL v2). Custom distributions must:
+- Include the original license and copyright notices
+- Clearly indicate any modifications made
+- Not use "Goose" trademarks in ways that imply official endorsement
+


This line uses "Goose" capitalized, but the repo’s documentation style guide requires the product name to be written as "goose" in docs/README/user-facing text; please change it to lowercase for consistent branding/searchability.

Copilot · 2026-02-12T02:44:28Z

CUSTOM_DISTROS.md

+2. **Bundle as a built-in extension** by adding to `ui/desktop/src/built-in-extensions.json`:
+
+```json
+{
+  "id": "internal-data",


The guide suggests adding a stdio extension entry (with cmd/args) to ui/desktop/src/built-in-extensions.json, but that file only contains metadata for builtin extensions (no cmd/args); update the instructions/example to match the actual schema and document the correct way to bundle a custom stdio MCP server.

* main: fix text editor view broken (#7167) docs: White label guide (#6857) Add PATH detection back to developer extension (#7161) docs: pin version in ci/cd (#7168) Desktop: - No Custom Headers field for custom OpenAI-compatible providers (#6681) feat: edit model and extensions of a recipe from GUI (#6804) feat: MCP support for agentic CLI providers (#6972)

* origin/main: (33 commits) fix: replace panic with proper error handling in get_tokenizer (#7175) Lifei/smoke test for developer (#7174) fix text editor view broken (#7167) docs: White label guide (#6857) Add PATH detection back to developer extension (#7161) docs: pin version in ci/cd (#7168) Desktop: - No Custom Headers field for custom OpenAI-compatible providers (#6681) feat: edit model and extensions of a recipe from GUI (#6804) feat: MCP support for agentic CLI providers (#6972) docs: keyring fallback to secrets.yaml (#7165) feat: load provider/model specified inside the recipe config (#6884) fix ask-ai bot hitting tool call limits (#7162) fix flatpak icon (#7154) [docs] Skills Marketplace UI Improvements (#7158) More no-window flags (#7122) feat: Allow overriding default bat themes using environment variables (#7140) Make the system prompt smaller (#6991) Pre release script (#7145) Spelling (#7137) feat(mcp): upgrade rmcp to 0.15.0 and advertise MCP Apps UI extension capability (#6927) ...

…provenance * origin/main: (68 commits) Upgraded npm packages for latest security updates (#7183) docs: reasoning effort levels for Codex provider (#6798) Fix speech local (#7181) chore: add .gooseignore to .gitignore (#6826) Improve error message logging from electron (#7130) chore(deps): bump jsonwebtoken from 9.3.1 to 10.3.0 (#6924) docs: standalone mcp apps and apps extension (#6791) workflow: auto-update cli-commands on release (#6755) feat(apps): Integrate AppRenderer from @mcp-ui/client SDK (#7013) fix(MCP): decode resource content (#7155) feat: reasoning_content in API for reasoning models (#6322) Fix/configure add provider custom headers (#7157) fix: handle keyring fallback as success (#7177) Update process-wrap to 9.0.3 (9.0.2 is yanked) (#7176) feat: support extra field in chatcompletion tool_calls for gemini openai compat (#6184) fix: replace panic with proper error handling in get_tokenizer (#7175) Lifei/smoke test for developer (#7174) fix text editor view broken (#7167) docs: White label guide (#6857) Add PATH detection back to developer extension (#7161) ... # Conflicts: # .github/workflows/nightly.yml

docs: White label guide

2fd8f79

Copilot AI review requested due to automatic review settings January 31, 2026 02:01

Copilot started reviewing on behalf of maniksurtani January 31, 2026 02:01 View session

Copilot AI reviewed Jan 31, 2026

View reviewed changes

katzdave requested a review from a team February 6, 2026 16:27

angiejones reviewed Feb 6, 2026

View reviewed changes

angiejones requested review from DOsinga and michaelneale February 6, 2026 16:49

michaelneale approved these changes Feb 9, 2026

View reviewed changes

angiejones self-assigned this Feb 9, 2026

michaelneale added 2 commits February 10, 2026 13:29

addressing feedback and adding docs

5024c0c

typos

e81fecc

Copilot AI review requested due to automatic review settings February 12, 2026 02:38

Copilot started reviewing on behalf of angiejones February 12, 2026 02:39 View session

angiejones approved these changes Feb 12, 2026

View reviewed changes

angiejones enabled auto-merge February 12, 2026 02:42

angiejones added this pull request to the merge queue Feb 12, 2026

Copilot AI reviewed Feb 12, 2026

View reviewed changes

Merged via the queue into main with commit ffc2471 Feb 12, 2026
27 checks passed

angiejones deleted the manik/whitelabel branch February 12, 2026 02:48

github-actions bot mentioned this pull request Feb 12, 2026

chore(release): release version 1.24.0 (minor) #7102

Open

BrewTestBot mentioned this pull request Feb 12, 2026

block-goose-cli 1.24.0 Homebrew/homebrew-core#267289

Merged

	- UI components: `ui/desktop/src/renderer/` (if using standard structure)
	- UI entry point: `ui/desktop/src/renderer.tsx`

	Example: Python ACP client (see `test_acp_client.py` for a complete example):
	Example: Python ACP client (simplified, self-contained example):

	client.send_request("initialize", {"protocolVersion": "2025-01-01"})
	client.send_request("initialize")

	- Test client example: `test_acp_client.py`
	- Test client example: see ACP documentation linked above

Conversation

maniksurtani commented Jan 31, 2026

Summary

Type of Change

AI Assistance

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Jan 31, 2026

Choose a reason for hiding this comment

Uh oh!

angiejones Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 31, 2026

Choose a reason for hiding this comment

Uh oh!

katzdave commented Feb 6, 2026

Uh oh!

angiejones Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

angiejones Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

michaelneale Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

angiejones commented Feb 6, 2026

Uh oh!

michaelneale left a comment

Choose a reason for hiding this comment

Uh oh!

maniksurtani commented Feb 9, 2026

Uh oh!

michaelneale commented Feb 10, 2026

Uh oh!

github-actions bot commented Feb 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

github-actions bot commented Feb 10, 2026 •

edited

Loading