Skip to content

Open source Grok Bot alternative, Bring your own agent and subscription: message Claude Code, Codex, Gemini CLI, Cursor, Copilot and 40+ AI agents as bots on your own computer, from iPhone, Mac, Windows, Linux or terminal. Agent-agnostic and free. Also a Muse and Dots alternative. Built in Rust.

5.2 KB
Raw Blame

User manual (codync.dev/docs)

The website has a user manual for people who use Codync: what a bot is, how to set one up, what it can do. It lives in the site (web/): one MDX file per page in web/content/docs/<slug>.mdx, the sidebar order and each page's title and description in web/app/docs/pages.ts, the pages' typography in web/mdx-components.tsx. The docs in this folder stay the contributor's reference; the manual says the same things for users.

Keep it current

A change a user can see or do differently updates the manual page that covers it, in the same change, like any other doc it makes stale: a new or renamed setting, button, command or flow, a new agent, a changed limit or number, a new privacy-relevant data flow. Add a page (file plus its pages.ts entry) when a feature fits none. The site deploys main to codync.dev and dev to a preview, so the manual goes live with the release that ships the change.

Pages and their sources

Page Covers Sources
getting-started Install, pair, first bot README.md, updates, dev app for names only
bots Creating, settings, workspaces, hiding, permissions, new session, importing from Grok Bot bot workspaces, conversation runtime, bot import
agents Known agents, registry, custom command, Extensions, sign-in, models extensions, host/src/agent/backends.rs
conversations Messages, files, approval cards, stop, replies, reactions, commands, fresh conversations, notifications, sending from a script (codync-host send) README.md (codync-host send), chat messages, file attachments, context and memory, notifications
groups Group chats groups and replies
teamwork Bots messaging bots, bots on your other computers, Manage the team bot collaboration, codync-network
cloud-assistants The MCP connector for ChatGPT, Claude and other assistants: turning it on, adding it, what it can do, privacy cloud assistants
routines Schedules, webhooks, runs routines
dev-servers Programs a bot keeps running: starting, ports, stopping dev servers
artifacts Artifacts, the Library artifacts
memory Layers, dreaming, the agent's own memory context and memory, bot memory
connectors-and-skills MCP connectors, apps, skills connector credentials, extensions
agent-fallbacks The fallback chain agent fallbacks
computer-use Remote screen, computer use remote screen, computer use
voice Calls, dictation, engines and keys voice calls
remote-access Relay, direct routes, pairing, accounts, reverse proxy, SSH computers remote protocol, accounts and SSH
linux-servers Headless install, reaching it, firewall, approvals Linux servers
updates App and host updates, version mismatch, uninstall updates, compatibility
privacy What stays on the computer, what Codync's services see, analytics analytics, remote protocol; keep it consistent with the policy page web/app/privacy/page.tsx

Writing rules

  • English only. Plain, short sentences in the second person. Name things the way the apps show them (the bot's settings, Manage the team), with the real English UI labels in bold; no source paths, type or method names unless the reader types them (a CLI command, an environment variable).
  • Where the apps differ, say how in each, briefly: iPhone, Desktop, Terminal UI.
  • Describe the current release only. Leave out the Android app until it's public, Codync 1.x, products the UI was modeled on, roadmap and internal investigations.
  • Every claim is checkable against the code or a doc above. Numbers and limits are written as the code has them. Security guidance (what the relay sees, loopback-only API, reverse-proxy rules) is exact.
  • MDX: the page's title (its # heading) and description live in pages.ts, so the file holds only ## and ### sections, lists and small tables, no images or components. Never a bare <, { or } in prose: put code, paths and placeholders in backticks. Link pages as /docs/<slug>, sections as /docs/<slug>#<heading-id>.
  • Check: in web/, npm run check:docs (also run by the pre-commit hook) compiles every page and checks that every /docs link and #anchor lands on an existing page and heading; npm run build must pass too.