Skip to content

tale-project/tale

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1,874 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Tale

The Orchestrator for AI Agents

Connect OpenClaw, Hermes Agent, Claude Code, Codex, Cursor, Gemini CLI, OpenCode, and Pi.
Pool their knowledge, delegate tasks, and build your swarm of agents.

License: MIT Docs Self-hosted

Quick start · What you can do · Commands · Documentation · Contributing

Read this in: English · Deutsch · Français


Tale is a self-hosted AI platform that turns the agents and CLIs your team already uses into one coordinated workforce. Give them a shared knowledge base, wire up your tools and integrations, and delegate work across them — agents, automations, and a unified inbox, all running on your own infrastructure. Install the CLI and run a single command to get started.

Pick your path:

  • Try Tale locally — install the CLI and run two commands on your own machine. Start with Quick start below.
  • Use Tale Cloud — let Tale operate the stack, sign up, and onboard your team. Start with Cloud onboarding.
  • Contribute — run Tale from source and ship a change back. Start with Contributor setup.

Quick start

Get Tale running on your machine in three commands — install the CLI, scaffold a project, start it. The CLI installs Docker if it's missing and generates every secret for you, so there is nothing to set up first and nothing to hand-edit.

Prerequisites for a local trial: none. The installer provisions Docker for you, and tale init generates every secret — you do not need to bring anything to get the stack running. An OpenRouter API key (or any OpenAI-compatible provider) is optional and only needed before an agent can answer: you add it in the app after sign-up, in the setup wizard or under Settings → AI providers. tale init does not ask for it.

Windows with Hyper-V backend: Ensure your project drive is shared in Docker Desktop Settings > Resources > File Sharing. WSL2 backend (default) requires no extra configuration.

1. Install the CLI

Linux / macOS:

curl -fsSL https://raw.githubusercontent.com/tale-project/tale/main/scripts/install-cli.sh | bash

Windows (PowerShell):

irm https://raw.githubusercontent.com/tale-project/tale/main/scripts/install-cli.ps1 | iex

2. Create a project

tale init my-project
cd my-project

The CLI asks one question — local trial or production domain — and configures everything for that target: TLS, all security secrets, AI-editor config files, and the platform source extracted to .tale/reference/ so AI-powered editors can create and edit configs with full platform awareness. The same project works for both a local trial and a real deployment.

3. Start Tale

tale dev

Visit https://localhost (or your configured domain) when you see "Tale Platform is running!"

Note: Your browser will show a certificate warning for self-signed certificates. This is safe to accept.

For detailed setup instructions, see the self-hosted quickstart.

What can you do?

Goal How
Create custom agents Edit JSON files in agents/ — define instructions, tools, and models
Build automations Edit JSON files in workflows/ — triggers, conditions, loops, AI steps
Add integrations Edit files in integrations/ — REST APIs, SQL databases, custom connectors
Use AI to build configs Open the project in Claude Code, Cursor, Copilot, or Windsurf — the AI knows your schemas
Chat with AI assistants Built into the platform — start chatting immediately
Build a knowledge base Upload documents, crawl websites, manage products and customers
Manage conversations Unified inbox for customer conversations with AI-assisted replies
View backend data Run tale convex admin and open the Convex Dashboard

All files in agents/, workflows/, and integrations/ are live-reloaded — edit and see changes instantly.

Command reference

Development

tale init [directory]              # Create a new project with example configs (no Docker needed)
tale dev                           # Start all services locally
tale dev --detach                  # Start in background
tale dev --port 8443               # Use a custom HTTPS port
tale update                        # Update the CLI + sync project files (then `tale deploy`; CLI self-aligns automatically)
tale convex admin                  # Generate Convex dashboard admin key
tale config                        # Manage CLI configuration

Production

tale deploy                        # Blue-green zero-downtime deployment of the current CLI version
tale status                        # Show deployment status
tale logs <service>                # View service logs
tale logs platform -f              # Follow log output
tale backup                        # Snapshot all data volumes
tale restore                       # List snapshots / restore one (stopped stack)
tale rollback                      # Roll back to the previous patch version
tale cleanup                       # Remove inactive containers
tale reset --force                 # Remove all containers

See the CLI reference for all options and flags. Upgrading an existing deployment requires a one-time manual migration: run tale migrate config-layout then tale deploy --override-all -y. See Self-hosted upgrades for the full runbook.

Deploy to production

tale deploy

The CLI handles blue-green zero-downtime deployments with automatic health checks and rollback. For full production setup including reverse proxy configuration and subpath deployment, see the Production deployment guide.

Authentication options

Tale uses password-based authentication by default. The first user creates the owner account; all other users are created by an admin. To enable self-service login, connect SSO or trusted headers via Microsoft Entra ID — see the Integrations overview for the Microsoft 365 connector that powers both document sync and SSO.

  • Microsoft Entra ID (SSO): Single sign-on with Microsoft 365 / Azure AD with automatic provisioning
  • Trusted headers: For deployments behind an authenticating reverse proxy (Authelia, Authentik, oauth2-proxy)

Development

For local development (non-Docker):

Prerequisites

Development commands

bun install                      # Install dependencies
bun run dev                      # Start development servers (spawns local Convex)
bun run typecheck                # Type checking
bun run lint                     # Linting
bun run test                     # Run tests
bun run build                    # Build all services

Optional: hybrid mode against a containerised Convex

You can run Vite locally against the dedicated convex container instead of spawning bunx convex dev:

docker compose up convex                        # in one terminal
CONVEX_EXTERNAL=true bun run dev                # in another (CONVEX_URL optional)

Useful when you want fast Vite reloads but a stable Convex backend that mirrors production. Set CONVEX_URL if your container exposes Convex on a non-default host/port.

Known issues

  • xlsx security vulnerability: The project uses xlsx@0.18.5 which has known security vulnerabilities (Prototype Pollution and ReDoS). This is the latest version available and no fix is currently released. The package is used for Excel file parsing in the documents feature.
  • ENVIRONMENT_FALLBACK warning: During platform build, you may see an ENVIRONMENT_FALLBACK error. This is a Convex-specific warning and doesn't prevent successful builds.

Documentation

The docs site and platform UI both ship three base locales (en, de, fr) plus regional variants where local wording differs (today: de-CH; the loader picks up any new xx-YY bundle automatically). Variants carry only the strings that differ from their base; missing keys fall back through the base to English. Start at docs/en/index.md to pick an entry point by persona.

For everyday users
For builders (agents, automations, integrations)
For admins
For operators
For developers
  • API reference — REST API for agents, chat, knowledge, and workflows
  • Webhooks — workflow and agent webhooks with signature verification
  • Develop overview — the developer surface end to end

Need help?

  • Logs: tale logs <service> to view service logs
  • Health checks: Visit {SITE_URL}/api/health
  • Deployment status: tale status to check production deployment
  • Convex Dashboard: tale convex admin to generate an admin key
  • Issues and discussions: github.com/tale-project/tale/issues

Contributing

New to the repo? Contributor setup is the single source of truth for getting the source running locally — prerequisites, bun install, the bun run setup:check pre-flight, and bun run dev. Read AGENTS.md before your first PR — it is the single contract for code style, security, testing, i18n, and documentation across every workspace. The docs skill covers the documentation site; the translation skill covers cross-locale translation rules. Run bun run check (format, lint, typecheck, tests) before opening a PR; the pull request template lists the rest of the pre-merge checklist.


Star history

Star History Chart

About

The Orchestrator for AI Agents — Connect OpenClaw, Hermes Agent, Claude Code, Codex, Cursor, Gemini CLI, OpenCode, and Pi. Pool their knowledge, delegate tasks, and build your swarm of agents.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors