Does Octop use paid AI services?

Can use OpenAI. Its settings have keys for this paid API. Its README says whether one is required.

Is Octop still maintained?

Yes, active. Last change today. Latest release v1.0.3b4, 4 days ago.

Some track record. 12k stars, 4 months old, by an organization. Get it from the official repo and read what it installs.

gitmanual

Reading the repo

Opening the box…

How to set up Octop (TencentCloud/Octop) · gitmanual

Assembly instructions

TencentCloud/Octop

A smarter, self-hosted AI assistant — multi-user, multi-agent.

Python#agent#agentic-ai#ai#ai-agent

Difficulty: Involved
Time: 30 min or more
Stars: ★ 11,798
Activity: Updated this month

Before you start

Is it free?: YesOpen source (MIT).
Paid AI services?: Can use OpenAIIts settings have keys for this paid API. Its README says whether one is required.
Still maintained?: Yes, activeLast change today. Latest release v1.0.3b4, 4 days ago.
Can I trust it?: Some track record12k stars, 4 months old, by an organization. Get it from the official repo and read what it installs.

Saved setup from 10 h ago

Will it work on macOS?

Yes, it installs on your macOS

A ready-made macOS download is in the latest release.

Your system

macOS Windows Linux

Start here

Website ↗octop.cloudThe project's own site.

Heads-upBuilding it yourself? It also needs PostgreSQL and 44 settings in .env (18 secret).

Download for macOS

v1.0.3b4 · 11/6/2026 ↗

Octop-desktop-darwin-arm64-1.0.3b4.dmg

dmg · Apple Silicon · 266.2 MB · 146 downloads · best match

Download

Drag the app into Applications.

curl -LO "https://github.com/TencentCloud/Octop/releases/download/v1.0.3b4/Octop-desktop-darwin-arm64-1.0.3b4.dmg"
open "Octop-desktop-darwin-arm64-1.0.3b4.dmg"

Other macOS downloads (3)

Octop-desktop-darwin-amd64-1.0.3b4.dmg

dmg · Intel · 275.1 MB · 32 downloads

Download

Drag the app into Applications.

curl -LO "https://github.com/TencentCloud/Octop/releases/download/v1.0.3b4/Octop-desktop-darwin-amd64-1.0.3b4.dmg"
open "Octop-desktop-darwin-amd64-1.0.3b4.dmg"

Octop-portable-darwin-arm64-1.0.3b4.zip

zip · Apple Silicon · 250.7 MB · 32 downloads

Download

If it contains an .app, move it to Applications.

curl -LO "https://github.com/TencentCloud/Octop/releases/download/v1.0.3b4/Octop-portable-darwin-arm64-1.0.3b4.zip"
unzip "Octop-portable-darwin-arm64-1.0.3b4.zip"

Octop-portable-darwin-amd64-1.0.3b4.zip

zip · Intel · 260.3 MB · 21 downloads

Download

If it contains an .app, move it to Applications.

curl -LO "https://github.com/TencentCloud/Octop/releases/download/v1.0.3b4/Octop-portable-darwin-amd64-1.0.3b4.zip"
unzip "Octop-portable-darwin-amd64-1.0.3b4.zip"

Install with a package manager

install script

curl -fsSL https://download.octop.cloud/octop/scripts/install.sh | bash

Pipes a remote script into your shell. Read it before running.

install script

curl -fsSL https://download.octop.cloud/octop/scripts/install.sh | bash -s -- --extras browser

Pipes a remote script into your shell. Read it before running.

pip

pip install octop

From the README, exactly as the maintainers wrote it.

Did you get it running?

No reports for macOS yet.

Still stuck? Ask an AI

Opens a chat with this manual already filled in, for macOS. It uses your own account; gitmanual sends nothing.

Ask Claude Ask ChatGPT

Parts list

1×Python >=3.12runtime
1×Docker tool
1×uv package manager
1×PostgreSQL service

44× settings in .env

OCTOP_PORT
OCTOP_LOG_LEVEL
OCTOP_BIND_HOST
OCTOP_ADMIN_USERNAMEoptional
OCTOP_DEFAULT_PASSWORDsecretoptional
OCTOP_ADMIN_DISPLAY_NAMEoptional
OPENAI_API_KEYsecretoptional
DASHSCOPE_API_KEYsecretoptional
LANGFUSE_TRACING_ENABLEDoptional
LANGFUSE_PUBLIC_KEYsecretoptional
LANGFUSE_SECRET_KEYsecretoptional
LANGFUSE_BASE_URLoptional
OPENAI_BASE_URL
OPENAI_MODEL_NAME
OSS_KIND
OSS_ENDPOINT
OSS_ACCESS_KEYsecret
OSS_SECRET_KEYsecret
OSS_BUCKET
OSS_REGION
OSS_PREFIX
ALI_OSS_KIND
ALI_OSS_ENDPOINT
ALI_OSS_ACCESS_KEYsecret
ALI_OSS_SECRET_KEYsecret
ALI_OSS_BUCKET
ALI_OSS_REGION
ALI_OSS_PREFIX
CONNECTOR_TENCENT_DOCS_TOKENsecret
CONNECTOR_TENCENT_MEETING_TOKENsecret
CONNECTOR_TENCENT_WEIYUN_TOKENsecret
CONNECTOR_YOUDAO_NOTE_TOKENsecret
CONNECTOR_TENCENT_NEWS_TOKENsecret
CONNECTOR_WECHAT_READING_TOKENsecret
CONNECTOR_QQ_MUSIC_TOKENsecret
CONNECTOR_FLIGGY_TOKENsecret
CONNECTOR_BAIDU_MAP_TOKENsecret
CONNECTOR_CTRIP_WENDAO_TOKENsecret
CONNECTOR_MEITUAN_TRAVEL_TOKENsecret
CONNECTOR_YUANDIAN_TOKENsecret
CONNECTOR_TENCENT_IMA_TOKENsecret
CONNECTOR_TENCENT_IMA_CLIENT_ID
CONNECTOR_TENCENT_LEXIANG_TOKENsecret
CONNECTOR_TENCENT_LEXIANG_COMPANY_FROM

Share this manual

Is this your repo?

Add a badge to your README so newcomers find these steps.

[![Setup manual](https://gitmanual.com/TencentCloud/Octop/badge.svg)](https://gitmanual.com/TencentCloud/Octop)

Good to know

Tool versions pinned in mise.toml — mise install (or asdf install) installs them all.
Has AGENTS.md — instructions for coding agents. You can open Claude Code (or another agent) in the cloned folder and ask it to do the setup for you.
Nested projects: dashboard/package.json, desktop/src/go.mod

Details

License: MIT
Open issues: 753
Branch: main

Files we read (12)

.env.example

.github/workflows/anti-spam-issues.yml

.github/workflows/auto-tag-on-release.yml

.github/workflows/ci.yml

.github/workflows/codeql.yml

.github/workflows/docker-publish.yml

.github/workflows/fnos-build-fpk.yml

CONTRIBUTING.md

Makefile

README.md

mise.toml

pyproject.toml

3,617 files in the repo