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.tsapps/mcp/src/index.tsfor the parked stdio wrapper onlypackages/db/prisma/schema.prisma
Start here
If you want to install Sally
If you want to understand the product quickly
- Product + workflow guide
- Workspace access, invite links, and shareable URLs
- Sally CRM
- Sally CI
- Sally Marketing
- Sally Marketing architecture notes
- Sally Marketing Website Integration Kit
- Sally Marketing AWS SES feedback setup
- Sally Marketing WordPress integration
- Sally Marketing local test recipe
- Architecture
- Storage
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-mcpas 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:
- use the high-level guides to understand the workflow
- use
docs/api.mdfor exact request/response and permission behavior - verify unusual edge cases in the source
Recommended reading order
For a new operator:
README.mddocs/product-guide.mddocs/ubuntu-debian-install.mddocs/mcp.mddocs/recovery.md
For an engineer or agent:
README.mddocs/api.mddocs/mcp.mddocs/tutorials.mddocs/ARCHITECTURE.md