From 4ebfebc3e059d11f38bf6088bb2cbc1c60935a0d Mon Sep 17 00:00:00 2001 From: Thomas des Francs Date: Thu, 14 May 2026 17:26:28 +0200 Subject: [PATCH] docs: update create app skill --- .../skills/create-an-app/SKILL.md | 51 ++++++++++++------- 1 file changed, 34 insertions(+), 17 deletions(-) diff --git a/packages/twenty-codex-plugin/skills/create-an-app/SKILL.md b/packages/twenty-codex-plugin/skills/create-an-app/SKILL.md index 1b018fee01a..f908152e63d 100644 --- a/packages/twenty-codex-plugin/skills/create-an-app/SKILL.md +++ b/packages/twenty-codex-plugin/skills/create-an-app/SKILL.md @@ -1,22 +1,22 @@ --- name: create-an-app -description: Use when the user wants to create or scaffold a new Twenty app with create-twenty-app. +description: Use when the user wants to create or scaffold a new Twenty app --- -# When to Use - -Use this when the user asks to create or scaffold a new Twenty app. - # Quickstart an App Use this as the default way to start an app unless the user gives different instructions. First, ask the user for: -- The app name. -- The workspace URL. +- The app name. +- Its Twenty workspace URL. -After they answer, run: +The directory name must contain only lowercase letters, numbers, and hyphens (you can transform the entered name to lowercase and replace spaces with hyphens). + +Remove any trailing `/` from the workspace URL, then run: + +Then run: ```bash npx create-twenty-app@latest --api-url @@ -24,20 +24,28 @@ cd yarn twenty dev ``` -Directory names passed to `create-twenty-app` must contain only lowercase letters, numbers, and hyphens. +If the user says they do not have a Twenty Cloud account or workspace URL, explain that they can create one at https://app.twenty.com/welcome. + +Tell them to send back the workspace URL once it is ready. + +At the bottom of that answer, add: +You can also start locally with Docker instead if you prefer (advanced setup) + +Then continue with the default flow: + +``` bash +npx create-twenty-app@latest --api-url +cd +yarn twenty dev +``` # Create an App with Local Docker -Use this only when the user wants to create an app against a local Twenty instance. +Use this only when the user explicitly wants a local Twenty app-dev server. -First, check whether Docker is installed and running: -```bash -docker --version -docker info -``` - -If Docker is missing or not running, ask whether the user wants to install Docker Desktop. Share this download link: `https://www.docker.com/products/docker-desktop/`. +First, ask the user for its app name +"How do you want to name your app?" Then run: @@ -47,6 +55,15 @@ cd yarn twenty dev ``` +If Docker is missing or not running, ask whether the user wants to install Docker Desktop. Share this download link: `https://www.docker.com/products/docker-desktop/`. + +Ask him to open Docker Desktop and ensure it is running. + +then try to launch the command again. + +Finally open the app in the browser. The default URL is `http://localhost:2020/`. + + # Next Steps Use `build-app-features` when the user wants to add objects, fields, logic functions, roles, views, navigation, page layouts, skills, agents, or front component registrations.