sally docs
This page is rendered from the canonical GitHub docs. Edit on GitHub.

Sally documentation

Sally is an API-first project management system for humans, agents, and internal operations.

This documentation set is intended to be useful in two ways:

  • for humans who want to install, operate, and use Sally day to day
  • for LLMs and agents that need implementation-backed references, concrete examples, and predictable workflows

If a page here disagrees with the actual implementation, trust the code in:

  • apps/api/src/index.ts
  • apps/mcp/src/index.ts for the parked stdio wrapper only
  • packages/db/prisma/schema.prisma

Start here

If you want to install Sally

If you want to understand the product quickly

If you want to integrate with the API

If you want to use MCP

If you want practical walkthroughs

If you need operations / recovery


Current product surface

Sally currently covers:

  • account login and session auth
  • workspaces and memberships
  • invites, invite links, invite management, and password reset flows
  • projects with default or custom statuses
  • project memberships including read-only viewer access
  • canonical workspace-scoped project and task URLs
  • tasks with priorities, descriptions, due dates, labels, todos, comments, and inline images
  • clients linked to projects
  • notifications for assignment and mentions
  • timesheets and reporting
  • hosted MCP via /mcp
  • Sally CRM and Marketing in Community by default
  • Pro custom roles, 2FA enforcement, and API/MCP key policy when a Pro or Enterprise license is installed
  • local stdio MCP via sally-mcp as a parked advanced/legacy path

Documentation style notes

This repo intentionally contains both:

  • high-level explanation docs for humans
  • implementation-backed reference docs for precise integration work

When in doubt:

  1. use the high-level guides to understand the workflow
  2. use docs/api.md for exact request/response and permission behavior
  3. verify unusual edge cases in the source

Recommended reading order

For a new operator:

  1. README.md
  2. docs/product-guide.md
  3. docs/ubuntu-debian-install.md
  4. docs/mcp.md
  5. docs/recovery.md

For an engineer or agent:

  1. README.md
  2. docs/api.md
  3. docs/mcp.md
  4. docs/tutorials.md
  5. docs/ARCHITECTURE.md