| .. | ||
| announcements | ||
| scripts | ||
| src | ||
| tests/e2e | ||
| .env | ||
| .eslintrc.json | ||
| .gitignore | ||
| .goosehints | ||
| .npmrc | ||
| .prettierignore | ||
| .prettierrc.json | ||
| components.json | ||
| entitlements.plist | ||
| eslint.config.js | ||
| forge.config.ts | ||
| forge.deb.desktop | ||
| forge.env.d.ts | ||
| forge.rpm.desktop | ||
| image.d.ts | ||
| index.html | ||
| openapi-ts.config.ts | ||
| openapi.json | ||
| package-lock.json | ||
| package.json | ||
| playwright.config.ts | ||
| README.md | ||
| tsconfig.json | ||
| tsconfig.node.json | ||
| vite.config.mts | ||
| vite.main.config.mts | ||
| vite.preload.config.mts | ||
| vite.renderer.config.mts | ||
| vitest.config.ts | ||
goose Desktop App
Native desktop app for goose built with Electron and ReactJS.
Building and running
goose uses Hermit to manage dependencies, so you will need to have it installed and activated.
git clone git@github.com:block/goose.git
cd goose
source ./bin/activate-hermit
cd ui/desktop
npm install
npm run start
Platform-specific build requirements
Linux
For building on Linux distributions, you'll need additional system dependencies:
Debian/Ubuntu:
sudo apt install dpkg fakeroot
Arch/Manjaro:
sudo pacman -S dpkg fakeroot
Fedora/RHEL:
sudo dnf install dpkg-dev fakeroot
Building notes
This is an electron forge app, using vite and react.js. goosed runs as multi process binaries on each window/tab similar to chrome.
Building for different platforms
macOS
npm run bundle:default will give you a goose.app/zip which is signed/notarized but only if you setup the env vars as per forge.config.ts (you can empty out the section on osxSign if you don't want to sign it) - this will have all defaults.
npm run bundle:preconfigured will make a goose.app/zip signed and notarized, but use the following:
f" process.env.GOOSE_PROVIDER__TYPE = '{os.getenv("GOOSE_BUNDLE_TYPE")}';",
f" process.env.GOOSE_PROVIDER__HOST = '{os.getenv("GOOSE_BUNDLE_HOST")}';",
f" process.env.GOOSE_PROVIDER__MODEL = '{os.getenv("GOOSE_BUNDLE_MODEL")}';"
This allows you to set for example GOOSE_PROVIDER__TYPE to be "databricks" by default if you want (so when people start goose.app - they will get that out of the box). There is no way to set an api key in that bundling as that would be a terrible idea, so only use providers that can do oauth (like databricks can), otherwise stick to default goose.
Linux
For Linux builds, first ensure you have the required system dependencies installed (see above), then:
- Build the Rust backend:
cd ../.. # Go to project root
cargo build --release -p goose-server
- Copy the server binary to the expected location:
mkdir -p src/bin
cp ../../target/release/goosed src/bin/
- Build the application:
# For ZIP distribution (works on all Linux distributions)
npm run make -- --targets=@electron-forge/maker-zip
# For DEB package (Debian/Ubuntu)
npm run make -- --targets=@electron-forge/maker-deb
The built application will be available in:
- ZIP:
out/make/zip/linux/x64/goose-linux-x64-{version}.zip - DEB:
out/make/deb/x64/goose_{version}_amd64.deb - Executable:
out/goose-linux-x64/goose
Windows
Use the existing Windows build process as documented.
Running with goosed server from source
Set VITE_START_EMBEDDED_SERVER=yes to no in .env.
Run cargo run -p goose-server from parent dir.
npm run start will then run against this.
You can try server directly with ./test.sh