cindy README

项目的 README,来自 github.com/makecindy/cindy。合并为一个 markdown 文件:README.md。

CINDY — Consider it done. The open-source AI agent that works out of the box, doing real work on your own computer.

English · 简体中文

License CI

Download Cindy  ·  Website  ·  Build with us  ·  Get help

★ GitHub Trending #1 · 2026.10.26

Cindy is an open-source AI agent, ready out of the box and yours to shape. Connect your computers and phone, bring the models and subscriptions you already use, and build a companion that knows how you like to work.

All your devices. One Cindy.

Your work computer, home desktop, laptop and phone belong together.

Your computer becomes your server: no server rental or self-hosting setup.

How connections and data work

For remote access to your computers, keep them online, sign in with the same account and enable the relevant permissions. Model sharing requires allowing remote access to that provider; remote desktop also needs its own permissions. Project files stay on their computer — remote access is not whole-disk sync. Cloud companions sync their conversations, memory, skills and shared attachments through Cindy's services; model providers process the requests sent to them. Provider and service billing still apply.

Keep your favorite agents. Get a better way to work.

Already using Claude Code or Codex? Cindy brings them together with Pi, then adds a shared interface, multi-device access, tools and a companion of your own.

Harness What it brings
Claude Code Claude Code's agent workflow, with Cindy's interface and connected tools.
Codex Codex's coding workflow, available alongside your other agents.
Pi A lean, open-source, extensible agent with support for multiple model providers.

Choose a supported harness and model combination, and change it as the work evolves. Your session stays in Cindy; switching harnesses hands off or rebuilds the engine context rather than making their internal states identical.

One agent not enough? Let her lead a team. Use different agents for planning, parallel implementation and independent review, with a shared goal and clear acceptance criteria.

Real work, in your actual tools

Work with your files, browser and apps. Ask for a change, inspect what happened, and keep working from the result. Answers can include charts, interactive controls and rich HTML, not just a wall of text.

Build a recurring routine with automations, or hand over work through connected chat channels such as Slack and Telegram. Connect more tools through Skills, plugins and MCP.

Ready from day one. Yours to shape over time.

Open source means more than visible — it means changeable. Build Cindy with us →

Start with what you already have

The client is free. Authorize a supported subscription you already pay for, including Claude Code or Codex plans, connect your own API keys, or use a local model. You can also use Cindy's managed model service. Provider limits and billing still apply; the free client does not mean unlimited model usage.

macOS · Windows · Linux · iOS · Android

Download Cindy · Service pricing

Linux users: see the Ubuntu, Arch Linux and Omarchy installation guide for installation, updates, keyring setup and migration from a manual install.

A few people noticed.

Cindy GitHub star history

Every star means something.


For developers

This repository contains Cindy's open-source desktop and mobile clients and their shared packages, organized as a pnpm monorepo.

What's in this repo

Path Description
apps/desktop Electron desktop client
apps/mobile Expo / React Native mobile client
packages/* Shared client capabilities (auth, device-link, agent orchestration, model providers, …)
apps/*-bin Tool binaries shipped with the desktop app; none are committed — claude-code, codex, and ripgrep are downloaded per platform by pnpm install, and the Android platform-tools binaries are fetched (pinned version, sha256-verified) before Windows packaging

Not in this repo: the backend service lives in a separate repository and is not part of this monorepo.

Mode Account requirement Availability
Hosted service Cindy cloud account Use Cindy's full hosted service. See pricing.
Skip Sign-In No Cindy sign-in required Choose “Skip Sign-In” on the login screen to use local agents; the app then shows the account state as “Not signed in”. Server-backed capabilities are unavailable in this state.

Prerequisites

Getting started

Contributor setup, Git LFS, dependency updates, and access requirements are maintained in CONTRIBUTING.en.md. Plugins are installed through SkillHub or manually.

Minimal entry point:

git clone https://github.com/makecindy/cindy.git
cd cindy
git lfs pull
pnpm install

Development entry points

# Mainland China Cindy account
pnpm restart:desktop:remote --region=cn

# Global Cindy account
pnpm restart:desktop:remote --region=global

Remote development uses your own Cindy cloud account and existing login state, so you can continue existing sessions and work while developing the client. Use cn for Mainland China accounts and global for everyone else; do not rely on the internal default. Full desktop, mobile, data-isolation, and validation workflows are in CONTRIBUTING.en.md.

“Skip Sign-In” on the login screen runs local agents without a Cindy account (shown in the app as “Not signed in”), not a connection to a local server. Server-backed capabilities are unavailable in this state.

About the default servers: the client connects to Cindy's official cloud services by default (endpoint manifests in config/endpoint.json and config/endpoint.global.json; desktop auto-updates also come from the official CDN). This is intentional — external developers don't need to self-host a server: sign in with your own Cindy account in a dev build and develop / test directly against the official servers.

Skill Hub migration uses two separate manifest fields: released clients keep using skillhubApiBaseUrl (the deprecated XD proxy), while current clients use cindySkillHubApiBaseUrl. The current client deliberately does not fall back to the legacy field when the new endpoint is absent.

Architecture

Contributing

Contributions go through pull requests into main. Read CONTRIBUTING.en.md first, then use .github/PULL_REQUEST_TEMPLATE.md. Every commit needs a Developer Certificate of Origin sign-off (git commit -s); a DCO check on each pull request enforces it, and no CLA is required. Please also follow CODE_OF_CONDUCT.en.md. For ordinary usage questions, see SUPPORT.en.md; report security issues privately through SECURITY.en.md.

Security

Never commit credentials or authorization files to the working tree. If you discover a security issue, follow SECURITY.en.md to report it privately rather than opening a public issue.

Privacy & telemetry

Official distribution builds include TapDB usage analytics for product-level aggregate statistics, including device identifiers, OS / app version, startup and activity events. Events are associated with your account ID after sign-in, so this is not fully anonymous. TapDB does not collect chat content, file content, or working-directory data.

You can disable usage analytics without editing code: on Desktop, use Settings → About → Usage statistics; on Mobile, use Usage statistics in Settings. The SDK checks the stored privacy-consent state and the statistics preference, which defaults to on. Accepting the Privacy Policy records consent; a one-time migration also records consent for eligible existing signed-in users.

Known Mobile exception: enterprise SSO skips the policy-acceptance step. If no analytics consent record exists and that sign-in is restored after restarting the app, the current migration can mark even a new installation as consented. With TapDB configured and statistics enabled, reporting can then start without explicit policy acceptance. See Mobile sign-in restoration and the consent migration. Turning off Usage statistics prevents reporting from being enabled by this migration.

Implementation: Desktop consent and settings, Desktop SDK, Mobile consent, and Mobile SDK.

Online heartbeats and diagnostic logs are separate mechanisms, unaffected by the usage statistics switch. Desktop sends heartbeats to Cindy services only during a verified cloud sign-in (account ID, platform, and version); local mode sends none. Desktop native crash dumps stay local and are never uploaded automatically. Diagnostic logs can be uploaded manually; a separate, default-off automatic crash log upload option is also available. Log uploads require privacy consent. See the heartbeat implementation and log upload rules.

Building from source? You are not required to keep analytics:

License / 许可证

Except as otherwise noted, the source code in this repository is licensed under the Apache License, Version 2.0. Individual source files do not carry per-file license headers; the repository-root LICENSE governs.

Model weights, datasets, prompts, trademarks, and other separately identified materials may be subject to their own license terms and are not automatically covered by the repository-level Apache-2.0 grant. Third-party open-source components retain their own copyright and license. Their attribution notices and SPDX SBOMs are managed under docs/legal/, with artifact-specific outputs in docs/legal/notices/. See NOTICE for this project's copyright and attribution information.

cindy (makecindy/cindy)

正在搜索数据库…

10.3K ·GitHub
这是什么?Cindy 是一个开箱即用的开源 AI 智能体,它把多个运行框架(harness,如 Claude Code 和 Codex)、模型和工具整合到一个智能体中,能在你的项目和应用里完成实际工作。
这是库,还是我需要安装的应用?这是一个应用:本仓库是开源客户端,包含 Electron 桌面应用和 Expo/React Native 移动应用,以 pnpm monorepo 的方式组织,后端服务则位于其他仓库。
我该如何搭建开发环境?克隆仓库,确保已安装前置依赖,然后按照 CONTRIBUTING.en.md 中记录的贡献者设置步骤操作(包括安装依赖、Git LFS 和访问权限要求)。
我需要 Claude Code 或 Codex 订阅,还是可以使用自己的模型?你可以登录官方 Cindy 服务,授权你已经付费的 Claude Code / Codex 套餐,接入自己的 API 密钥,或者改用本地模型。
这个仓库也包含后端服务吗?不包含。驱动官方 Cindy 服务的后端位于单独的非公开仓库中,不属于本 monorepo。
我可以在哪些平台上运行 Cindy?桌面客户端(Electron)支持 macOS、Windows 和 Linux,移动客户端(Expo/React Native)支持 iOS 和 Android;另外还有专门的 Linux 安装指南,涵盖 Ubuntu、Arch 和 Omarchy。
我登录后,Cindy 会回传哪些数据?官方构建包含与设备、操作系统、应用版本及你的账号 ID 关联的 TapDB 分析数据,以及定期的在线心跳(账号 ID、平台、版本)。不会收集聊天内容、文件内容或工作目录数据,崩溃转储则保留在本地。
同时混用多个运行框架和模型有什么意义?运行框架和模型可以在任务进行中切换,而工作区、记忆、技能和工具保持连贯;一个任务甚至可以在不同的“运行框架 × 模型”组合之间完成规划、并行执行和审查。
如果我使用“跳过登录”,而不是 Cindy 账号,会怎样?“跳过登录”允许你在没有任何 Cindy 账号的情况下运行本地智能体(状态显示为“未登录”),但在此状态下,依赖服务器的功能将不可用。
Cindy 能在聊天窗口之外行动吗?可以。它能直接操控你的浏览器、电脑和手机,还能接收即时通讯应用中的任务,并按计划执行。
我能教 Cindy 新技能或自动化流程吗?可以。记忆功能让你只需纠正她一次,就能在各个运行框架之间持续生效;技能功能让你只需教一次工作流程,就能到处复用;自动化功能则能让周期性工作自行排期并运行。
有哪些类似的项目?rakazo, holaOS, Codync, Agentlas-OS, rome, paseo, ZCode, vicoa
作者
makecindy
大小
1.3 GB
星标
10.3K
时长
3个月
提交 · 90 天