Subshell Docs

Developers

Develop Subshell and its plugin integrations from the public repository.

Contribute

Contribute to Subshell covers the workspace, local development, tests, and contribution licensing. Write documentation describes the MDX authoring and verification contract.

The repository is public and dual-licensed. Server implementations are AGPL-3.0-only; the rest of the project is Apache-2.0, with an explicit additional permission for API type declarations.

Build a plugin

Plugin API explains the factory and manifest contract. Choose Build a harness plugin for an agent CLI or Build a network plugin for a network connection.

Publish a plugin covers bundled output and administrator installation. Plugins must work when loaded by a compiled binary without a neighboring node_modules directory.

Integration reference

Build an API integration covers schemas, TypeScript clients, credential boundaries, errors, retries, and WebSocket access.

For agents calling the product, use MCP tool reference. For external scripts, use REST API. The generated OpenAPI page on a running server supplies endpoint schemas.

Work on previews and displays

Web preview architecture covers HTTP/WebSocket forwarding and browser watching. Develop and extend web previews provides a runnable target and explains where implementation changes belong.

Virtual display architecture explains the provider contract and lifecycle. Follow Implement a virtual display provider for a runnable Linux example, registration, and validation.

BetterDisplay integration protocol documents the macOS provider’s CLI, local helper messages, and RFB viewer transport.

Next steps

Read the owning app's AGENTS.md before changing its implementation. Root project documentation routes to deeper engineering topics when needed.

Edit on GitHub

Last updated on

On this page