twenty/packages/twenty-codex-plugin/skills/manage-app/SKILL.md

name, description

name	description
manage-app	Use when the user wants to manage or troubleshoot tooling, remotes, sync, build, deploy, logs, CI/CD, or operational workflows for an existing Twenty app.

When To Use

Pick this skill when the user wants to operate, troubleshoot, or ship an existing Twenty app — anything between "I have an app" and "it runs in production". Representative triggers:

• "sync my app changes to the server"
• "deploy my Twenty app to production"
• "check the logs for my logic function"
• "switch to a different Twenty remote / instance"
• "add a new remote for staging"
• "set up CI/CD for my Twenty app"
• "troubleshoot a failed deploy / sync / build"
• "uninstall my app from production"
• "run tests for my Twenty app"
• "run my logic function manually for testing"

Do not use this skill to scaffold (use create-app), to change app entities or code (use develop-app), to prepare marketplace assets (use publish-app), or to query workspace records (use use-twenty-mcp).

Boundaries

For background on how Twenty apps work — the SDK packages, remotes, sync lifecycle, and rendering model — read ../../references/concepts/how-apps-work.md.

Do not scaffold a new app here. Use $create-app when the app does not exist.

Do not add or modify app entities here. Use $develop-app for objects, fields, logic functions, roles, views, navigation, page layouts, skills, agents, connection providers, and front component registration.

Do not prepare marketplace README, screenshots, logos, or npm listing copy here. Use $publish-app for public listing work.

Do not retrieve CRM records here. Use $use-twenty-mcp for workspace data retrieval.

Operating Rules

First confirm the current directory is a Twenty app:

test -f package.json
test -f src/application-config.ts

Inspect current app and scripts before running operational commands:

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.

For command details, remotes, validation command semantics, sync modes, troubleshooting, build, deploy, logs, exec, and CI/CD, read ../../references/manage-app/cli-and-sync.md.

If the user asks to run tests, also read ../../references/develop-app/tests.md before running any test command. Full test suites include integration tests that install and uninstall the app on their target server, so start or verify the isolated test instance and run:

yarn twenty docker:start --test
TWENTY_API_URL=http://localhost:2021 yarn test

Do not run integration tests against the dev instance on http://localhost:2020 unless the user explicitly asks for that target. If the user asks for unit tests only, use the package's unit-test script and no TWENTY_API_URL override is needed.

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 apply

Do not use bare yarn twenty dev (watch mode). Run yarn twenty apply 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.

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 apply --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 apply --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.

For build or deploy issues:

• Run yarn twenty dev:build before yarn twenty app:publish --private or yarn twenty app:publish.
• Check package.json version when updating an already deployed app.
• Confirm the target with yarn twenty app:publish --private --remote <name> instead of relying on the active remote when production is involved.

For runtime behavior:

• Use yarn twenty dev:function:logs to inspect function execution logs.
• Use yarn twenty dev:function:exec -n <function-name> -p '<json>' to reproduce a logic function with a controlled payload.

For CI/CD failures:

• Check .github/workflows/.
• Confirm TWENTY_DEPLOY_URL points to a reachable server from the runner.
• Confirm TWENTY_DEPLOY_API_KEY is configured as a secret, not committed in source.

Build And Deploy

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 $publish-app instead when the user wants npm marketplace publishing, listing copy, screenshots, or public app store metadata.

Logs, Exec, And Cleanup

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

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.