twenty/packages/twenty-codex-plugin/references/manage-app/cli-and-sync.md

CLI And Sync

Use this reference for Twenty app CLI command behavior, remotes, authentication, sync, validation commands, build, deploy, logs, function execution, and CI/CD troubleshooting.

Use ../develop-app/app-structure.md only for app file layout and post-entity-edit validation checklists.

App Checks

Before running operational commands, confirm the current directory is a Twenty app and inspect the active scripts and remotes:

test -f package.json
test -f src/application-config.ts
sed -n '1,220p' package.json
yarn twenty remote:list

Treat deploys, uninstalls, production remote changes, and production syncs as externally visible actions. Ask for explicit confirmation before running them when the target is production or user data could be affected.

Validation Commands

Use these commands to validate an app after changes:

yarn twenty dev:typecheck
yarn lint
yarn twenty dev --once

yarn twenty dev:typecheck checks generated app types and TypeScript compatibility. yarn lint checks local lint rules. yarn twenty dev --once performs a bounded build/sync against the active remote.

If a validation command fails because of entity definitions, switch to develop-app for the fix. If it fails because of remotes, authentication, build tooling, sync, logs, deploys, or CI/CD, stay in manage-app.

Remotes

A remote is a Twenty server that the app can sync or deploy to. Credentials are stored locally in ~/.twenty/config.json.

Common commands:

# Add a remote interactively.
yarn twenty remote:add

# Connect to a local Twenty server.
yarn twenty remote:add --local

# Add a remote non-interactively.
yarn twenty remote:add --url https://your-twenty-server.com --api-key $TWENTY_API_KEY --as production

# List configured remotes.
yarn twenty remote:list

# Switch the active remote.
yarn twenty remote:use <name>

When the user says "prod", "production", or "workspace de prod", identify the target remote before syncing or deploying. If it is missing, add it with --as production or the user-provided name.

Development Sync

Always use one-shot sync to synchronize app changes with the active remote:

yarn twenty dev --once

Do not use bare yarn twenty dev (watch mode). Run yarn twenty dev --once each time changes need to be synced.

One-shot sync requires an authenticated remote. If authentication fails, re-add or switch the remote before retrying.

Use verbose one-shot sync for bounded troubleshooting:

yarn twenty dev --once --verbose

Troubleshooting

Start by identifying which layer is failing:

• Remote/authentication.
• Dev sync or one-shot sync.
• Build/package generation.
• Deploy/upload/install.
• Runtime function execution.
• CI/CD environment or secrets.

Collect the minimum useful context before changing configuration:

sed -n '1,220p' package.json
sed -n '1,220p' src/application-config.ts
yarn twenty remote:list
yarn twenty dev --once --verbose

For remote or authentication issues:

• Check that the active remote is the intended workspace or server.
• Re-run yarn twenty remote:add --local for local app-dev servers.
• Re-run yarn twenty remote:add --url <url> --as <name> for remote servers.
• Avoid overwriting a production remote until the target URL is confirmed.

For sync issues:

• Prefer yarn twenty dev --once --verbose to get a bounded failure.
• Check generated type or schema errors before editing app entities.
• If the app depends on a changed data model, use develop-app to fix the entity definitions.

Build, Deploy, Logs, And Exec

Build before deploy when the user asks for release readiness or when debugging packaging issues:

yarn twenty dev:build

Publish an app to npm, or publish privately to a configured Twenty server registry:

yarn twenty app:publish
yarn twenty app:publish --private --remote production
yarn twenty app:install --remote production

Before deploying an update, check that package.json has a strictly higher semver version than the currently deployed version. Re-deploying the same version is rejected. After a private publish, install the deployed version with yarn twenty app:install when the target workspace should use it.

Use function logs when debugging runtime behavior on the connected server:

yarn twenty dev:function:logs
yarn twenty dev:function:logs -n <function-name>

Run a logic function manually when testing behavior without its trigger:

yarn twenty dev:function:exec -n <function-name>
yarn twenty dev:function:exec -n <function-name> -p '{"key":"value"}'

Uninstall only after confirmation:

yarn twenty app:uninstall
yarn twenty app:uninstall --yes

Integration tests install and uninstall the app on their target server, so run them against the isolated test instance (yarn twenty docker:start --test, port 2021) rather than the dev instance — see ../develop-app/tests.md.

CI/CD

Apps generated with create-twenty-app can use GitHub Actions for CI and CD. For deployment automation, check the app's .github/workflows/ files and configure:

• TWENTY_DEPLOY_URL
• TWENTY_DEPLOY_API_KEY

Do not put API keys in source files. Use the repository or CI secret store.