Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.twenty.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Managing the local server

Use yarn twenty server to control the local Twenty container:
CommandWhat it does
yarn twenty server startStart the server (pulls the image if needed)
yarn twenty server start --port 3030Start on a custom port
yarn twenty server stopStop the server (preserves data)
yarn twenty server statusShow URL, version, and login credentials
yarn twenty server logsStream server logs
yarn twenty server resetWipe data and start fresh
yarn twenty server upgradePull the latest twenty-app-dev image
yarn twenty server upgrade 2.2.0Upgrade to a specific version
Data persists across restarts in two Docker volumes (twenty-app-dev-data for PostgreSQL, twenty-app-dev-storage for files). Use reset to wipe everything.

​
Upgrading the server image

yarn twenty server upgrade pulls the latest image, compares digests, and only recreates the container if anything actually changed. Volumes are preserved — only the container is replaced. If a new image was pulled and the container was running, the upgrade automatically starts a new container; run yarn twenty server start afterward to wait for it to become healthy. 
yarn twenty server upgrade            # Latest
yarn twenty server upgrade 2.2.0      # Specific version
Verify the running version with yarn twenty server status (it shows the APP_VERSION baked into the container).

​
Running a parallel test instance

Pass --test to any server command to manage a second, fully isolated instance — useful for integration tests or experiments without touching your main dev data:
CommandWhat it does
yarn twenty server start --testStart the test instance (defaults to port 2021)
yarn twenty server stop --testStop it
yarn twenty server status --testShow its status
yarn twenty server logs --testStream its logs
yarn twenty server reset --testWipe its data
yarn twenty server upgrade --testUpgrade its image
The test instance has its own container (twenty-app-dev-test), volumes (twenty-app-dev-test-data, twenty-app-dev-test-storage), and config — it runs alongside your main instance without conflicts. Combine --test with --port to override 2021.

​
Manual setup (without the scaffolder)

Skip the scaffolder if you’re adding the SDK to an existing project: 
yarn add twenty-sdk twenty-client-sdk
Add the script to package.json: 
{
  "scripts": {
    "twenty": "twenty"
  }
}
You can now run yarn twenty dev, yarn twenty server start, and the rest.
Don’t install twenty-sdk globally — pin it per project so each app uses its own version.