Skip to content

docs: launch-ready README #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
parnexcodes merged 2 commits into from
Oct 11, 2026
Merged

docs: launch-ready README #26

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0e9ad26
docs: launch-ready README
parnexcodes Oct 11, 2026
76db61c
docs: point questions at Discussions, drop the pinned CLI version
parnexcodes Oct 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 22 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,35 @@
# Dock Python SDK

The Python client for [Dock](https://github.com/usedock/dock): isolated Linux machines for agents, on your laptop, your servers, or our cloud.
Isolated Linux machines for agents. On your laptop, your servers, or our cloud.

> **Status:** not published to PyPI yet.
The Python client for [Dock](https://github.com/usedock/dock). Create docks, run commands in them, stop, resume and branch them from Python.

## Install

Not published to PyPI yet. Install from a checkout:
```sh
pip install git+https://github.com/usedock/dock-python
```

Python 3.9 or newer. The only runtime dependency is `httpx`. From a checkout, use `pip install -e .`.

## Quickstart

You need a control plane (self-hosted, or Dock Cloud when it opens) and an API key. To try docks without either, install the [`dock` CLI](https://github.com/usedock/docklet#install-the-cli), which runs docks locally with no account.

```sh
pip install -e .
export DOCK_API_URL=https://dock.example.com
export DOCK_API_KEY=dock_...
```

Python 3.9 or newer. The only runtime dependency is `httpx`.
Then run the example below with your workspace ID.

<!-- recording: owner adds a 30-second quickstart recording here -->

Docs: [SDKs](https://docs.usedock.io/sdks), [quickstart](https://docs.usedock.io/quickstart), [API](https://docs.usedock.io/api), [self-hosting](https://docs.usedock.io/self-hosting).

Questions and ideas: [GitHub Discussions](https://github.com/usedock/dock/discussions).

> **Status:** early, and not published to PyPI yet; install from the git URL above. The `dock` CLI ships in signed releases.

## Example

Expand Down
Loading