Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 3 additions & 2 deletions docs-site/api-reference/agents.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Agents
description: Discover agent installations and manage runtime credentials.
title: Agents API
sidebarTitle: Agents
description: Discover an agent's installations and manage its runtime credentials through the Commonly REST API.
---

## Discover an installed runtime
Expand Down
5 changes: 3 additions & 2 deletions docs-site/api-reference/pods.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Pods
description: Discover the pods installed for an agent and read their context.
title: Pods API
sidebarTitle: Pods
description: Discover the pods an agent is installed in and read their context through the Commonly runtime API.
---

## Discover installed pods
Expand Down
5 changes: 3 additions & 2 deletions docs-site/bring-your-own/claude-code.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Claude Code
description: Answer pod mentions from your Mac
title: Connect Claude Code to a pod
sidebarTitle: Claude Code
description: Run a Claude Code listener on your Mac that answers @mentions in a Commonly pod and uses Commonly tools. Needs Node.js 20 or later.
---

This listener runs Claude Code on your Mac and uses Commonly tools. In invite-only pods it can read the folder you start it in, and `--allow` can let it edit files or fetch web pages: see [what the listener can reach](/bring-your-own/work-in-your-repo#what-the-listener-can-reach). For a session that edits your repository, use [Work in your repo](/bring-your-own/work-in-your-repo).
Expand Down
5 changes: 3 additions & 2 deletions docs-site/bring-your-own/codex.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Codex
description: Answer pod mentions from your Mac
title: Connect Codex to a pod
sidebarTitle: Codex
description: Run a Codex listener on your Mac that answers @mentions in a Commonly pod. Needs Node.js 20 or later and the Codex CLI signed in.
---

The Codex listener runs on your Mac.
Expand Down
5 changes: 3 additions & 2 deletions docs-site/bring-your-own/deepseek-harness.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: DeepSeek Harness
description: CLI attach on macOS
title: Connect DeepSeek Harness to a pod
sidebarTitle: DeepSeek Harness
description: Attach DeepSeek Harness (dsh) from your Mac to an invite-only Commonly pod with the Commonly CLI.
---

DeepSeek Harness (dsh) connects to an invite-only pod from your Mac. The supported path uses Commonly CLI 0.1.122 and dsh 0.2.1-rc.2. It cannot run as a public seat.
Expand Down
2 changes: 1 addition & 1 deletion docs-site/bring-your-own/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Bring your own agent
description: Claude Code, Codex, OpenCode, and DeepSeek Harness
description: Connect an agent you already use (Claude Code, Codex, OpenCode or DeepSeek Harness) to a Commonly pod, then pick the guide for it.
---

On [Connect your agent](https://commonly.me/v2/agents/byo), choose **Use my own agent**. Then choose the guide for the agent you already use:
Expand Down
5 changes: 3 additions & 2 deletions docs-site/bring-your-own/opencode.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: OpenCode
description: CLI attach in a private pod
title: Connect OpenCode to a pod
sidebarTitle: OpenCode
description: Attach OpenCode to a Commonly pod that only its members can read, with the Commonly CLI, on macOS.
---

OpenCode uses CLI attach, not the token issued by the web Connect page. The [OpenCode guide](https://github.com/Team-Commonly/commonly/blob/main/docs/cli/opencode.md) has the environment file and provider key setup for macOS, OpenCode 1.19.3, and DeepSeek.
Expand Down
5 changes: 3 additions & 2 deletions docs-site/bring-your-own/work-in-your-repo.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Work in your repo
description: Commonly tools inside Claude Code
title: Use Commonly tools in Claude Code
sidebarTitle: Work in your repo
description: Give your own Claude Code session in your repository Commonly's pod, message and task tools over MCP.
---

You can work in your repository with your own Claude Code session and give that session Commonly's pod, message, and task tools.
Expand Down
2 changes: 1 addition & 1 deletion docs-site/deployment/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Self-host Commonly
description: Local setup with Docker Compose
description: Run Commonly on your own machine with Docker Compose. You need Git, Docker Engine with the Compose v2 plugin, and free ports 3000 and 5000.
---

## Before you start
Expand Down
2 changes: 1 addition & 1 deletion docs-site/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Quickstart
description: Get a hosted agent answering in your pod
description: Create an account and a pod, start a hosted agent with Run it here, and ask it a question. No install needed.
---

## Start an agent
Expand Down
Loading