The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
Fix documentation (#18917)
martmull341c13bf3276
diff --git a/packages/twenty-docs/developers/extend/apps/building.mdx b/packages/twenty-docs/developers/extend/apps/building.mdxindex 1a695c79feb..b28a09324ba 100644--- a/packages/twenty-docs/developers/extend/apps/building.mdx+++ b/packages/twenty-docs/developers/extend/apps/building.mdx@@ -554,7 +554,7 @@ export default defineFrontComponent({Key points:- Front components are React components that render in isolated contexts within Twenty.- The `component` field references your React component.-- Components are built and synced automatically during `yarn twenty app:dev`.+- Components are built and synced automatically during `yarn twenty dev`.You can create new front components in two ways:@@ -597,7 +597,7 @@ You can create new skills in two ways:### Generated typed clients-Two typed clients are auto-generated by `yarn twenty app:dev` and stored in `node_modules/twenty-sdk/generated` based on your workspace schema:+Two typed clients are auto-generated by `yarn twenty dev` and stored in `node_modules/twenty-sdk/generated` based on your workspace schema:- **`CoreApiClient`** — queries the `/graphql` endpoint for workspace data- **`MetadataApiClient`** — queries the `/metadata` endpoint for workspace configuration and file uploads@@ -612,7 +612,7 @@ const metadataClient = new MetadataApiClient();const { currentWorkspace } = await metadataClient.query({ currentWorkspace: { id: true } });```-Both clients are re-generated automatically by `yarn twenty app:dev` whenever your objects or fields change.+Both clients are re-generated automatically by `yarn twenty dev` whenever your objects or fields change.#### Runtime credentials in logic functionsdiff --git a/packages/twenty-docs/developers/extend/apps/getting-started.mdx b/packages/twenty-docs/developers/extend/apps/getting-started.mdxindex 8e8dc422747..65d851c0972 100644--- a/packages/twenty-docs/developers/extend/apps/getting-started.mdx+++ b/packages/twenty-docs/developers/extend/apps/getting-started.mdx@@ -31,7 +31,7 @@ npx create-twenty-app@latest my-twenty-appcd my-twenty-app# Start dev mode: automatically syncs local changes to your workspace-yarn twenty app:dev+yarn twenty dev```The scaffolder supports two modes for controlling which example files are included:@@ -63,7 +63,7 @@ yarn twenty function:execute --preInstallyarn twenty function:execute --postInstall# Uninstall the application from the current workspace-yarn twenty app:uninstall+yarn twenty uninstall# Display commands' helpyarn twenty help@@ -165,7 +165,7 @@ export default defineObject({Later commands will add more files and folders:-- `yarn twenty app:dev` will auto-generate two typed API clients in `node_modules/twenty-sdk/generated`: `CoreApiClient` (for workspace data via `/graphql`) and `MetadataApiClient` (for workspace configuration and file uploads via `/metadata`).+- `yarn twenty dev` will auto-generate two typed API clients in `node_modules/twenty-sdk/generated`: `CoreApiClient` (for workspace data via `/graphql`) and `MetadataApiClient` (for workspace configuration and file uploads via `/metadata`).- `yarn twenty entity:add` will add entity definition files under `src/` for your custom objects, functions, front components, roles, skills, and more.## Authentication@@ -219,7 +219,7 @@ Then add a `twenty` script:}```-Now you can run all commands via `yarn twenty <command>`, e.g. `yarn twenty app:dev`, `yarn twenty help`, etc.+Now you can run all commands via `yarn twenty <command>`, e.g. `yarn twenty dev`, `yarn twenty help`, etc.## How to use a local Twenty instance@@ -237,7 +237,7 @@ yarn twenty remote add --local --port 3000- Authentication errors: run `yarn twenty auth:login` and ensure your API key has the required permissions.- Cannot connect to server: verify the API URL and that the Twenty server is reachable.-- Types or client missing/outdated: restart `yarn twenty app:dev` — it auto-generates the typed client.-- Dev mode not syncing: ensure `yarn twenty app:dev` is running and that changes are not ignored by your environment.+- Types or client missing/outdated: restart `yarn twenty dev` — it auto-generates the typed client.+- Dev mode not syncing: ensure `yarn twenty dev` is running and that changes are not ignored by your environment.Discord Help Channel: https://discord.com/channels/1130383047699738754/1130386664812982322diff --git a/packages/twenty-docs/developers/extend/apps/publishing.mdx b/packages/twenty-docs/developers/extend/apps/publishing.mdxindex 23324172f56..3cbcfaee14c 100644--- a/packages/twenty-docs/developers/extend/apps/publishing.mdx+++ b/packages/twenty-docs/developers/extend/apps/publishing.mdx@@ -28,13 +28,13 @@ Publishing to npm makes your app discoverable in the Twenty marketplace. Any Twe1. **Build your app** — the CLI compiles your TypeScript sources and generates the application manifest:```bash filename="Terminal"-yarn twenty app:build+yarn twenty build```2. **Publish to npm** — push the built package to the npm registry:```bash filename="Terminal"-npx twenty app:publish+npx twenty publish```### Auto-discovery@@ -65,14 +65,14 @@ jobs:node-version: "24"registry-url: https://registry.npmjs.org- run: yarn install --immutable- - run: npx twenty app:build+ - run: npx twenty build- run: npm publish --provenance --access publicworking-directory: .twenty/outputenv:NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}```-For other CI systems (GitLab CI, CircleCI, etc.), the same three commands apply: `yarn install`, `npx twenty app:build`, then `npm publish` from `.twenty/output`.+For other CI systems (GitLab CI, CircleCI, etc.), the same three commands apply: `yarn install`, `npx twenty build`, then `npm publish` from `.twenty/output`.<Tip>**npm provenance** is optional but recommended. Publishing with `--provenance` adds a trust badge to your npm listing, letting users verify the package was built from a specific commit in a public CI pipeline. See the [npm provenance docs](https://docs.npmjs.com/generating-provenance-statements) for setup instructions.@@ -87,7 +87,7 @@ For apps you don't want publicly available — proprietary tools, enterprise-onlBuild your app and deploy it to a specific server in one step:```bash filename="Terminal"-npx twenty app:publish --server <server-url>+npx twenty publish --server <server-url>```Any workspace on that server can then install and upgrade the app from the **Applications** settings page.@@ -97,7 +97,7 @@ Any workspace on that server can then install and upgrade the app from the **AppTo release an update:1. Bump the `version` field in your `package.json`-2. Push a new tarball with `npx twenty app:publish --server <server-url>`+2. Push a new tarball with `npx twenty publish --server <server-url>`3. Workspaces on that server will see the upgrade available in their settings<Note>@@ -110,7 +110,7 @@ Twenty organizes apps into three categories based on how they're distributed:| Category | How it works | Visible in marketplace? ||----------|-------------|------------------------|-| **Development** | Local dev mode apps running via `yarn twenty app:dev`. Used for building and testing. | No |+| **Development** | Local dev mode apps running via `yarn twenty dev`. Used for building and testing. | No || **Published** | Apps published to npm with the `twenty-app-` prefix. Listed in the marketplace for any workspace to install. | Yes || **Internal** | Apps deployed via tarball to a specific server. Available only to workspaces on that server. | No |diff --git a/packages/twenty-docs/developers/extend/capabilities/apps.mdx b/packages/twenty-docs/developers/extend/capabilities/apps.mdxindex a1210cb69a4..1e3e1f9a088 100644--- a/packages/twenty-docs/developers/extend/capabilities/apps.mdx+++ b/packages/twenty-docs/developers/extend/capabilities/apps.mdx@@ -108,13 +108,13 @@ yarn twenty function:execute --preInstallyarn twenty function:execute --postInstall# Build the app for distribution-yarn twenty app:build+yarn twenty build# Publish the app to npm or a Twenty server-yarn twenty app:publish+yarn twenty publish# Uninstall the application from the current workspace-yarn twenty app:uninstall+yarn twenty uninstall# Display commands' helpyarn twenty help@@ -219,7 +219,7 @@ export default defineObject({Later commands will add more files and folders:-- `yarn twenty app:dev` will auto-generate two typed API clients in `node_modules/twenty-sdk/clients`: `CoreApiClient` (for workspace data via `/graphql`) and `MetadataApiClient` (for workspace configuration and file uploads via `/metadata`).+- `yarn twenty dev` will auto-generate two typed API clients in `node_modules/twenty-sdk/clients`: `CoreApiClient` (for workspace data via `/graphql`) and `MetadataApiClient` (for workspace configuration and file uploads via `/metadata`).- `yarn twenty entity:add` will add entity definition files under `src/` for your custom objects, functions, front components, roles, skills, and more.## Authentication@@ -868,7 +868,7 @@ export default defineFrontComponent({Key points:- Front components are React components that render in isolated contexts within Twenty.- The `component` field references your React component.-- Components are built and synced automatically during `yarn twenty app:dev`.+- Components are built and synced automatically during `yarn twenty dev`.You can create new front components in two ways:@@ -1194,7 +1194,7 @@ You can create new agents in two ways:### Generated typed clients-Two typed clients are auto-generated by `yarn twenty app:dev` and stored in `node_modules/twenty-sdk/clients` based on your workspace schema:+Two typed clients are auto-generated by `yarn twenty dev` and stored in `node_modules/twenty-sdk/clients` based on your workspace schema:- **`CoreApiClient`** — queries the `/graphql` endpoint for workspace data- **`MetadataApiClient`** — queries the `/metadata` endpoint for workspace configuration and file uploads@@ -1210,7 +1210,7 @@ const metadataClient = new MetadataApiClient();const { currentWorkspace } = await metadataClient.query({ currentWorkspace: { id: true } });```-`CoreApiClient` is re-generated automatically by `yarn twenty app:dev` whenever your objects or fields change. `MetadataApiClient` ships pre-built with the SDK.+`CoreApiClient` is re-generated automatically by `yarn twenty dev` whenever your objects or fields change. `MetadataApiClient` ships pre-built with the SDK.#### Runtime credentials in logic functions@@ -1280,10 +1280,10 @@ Once you've developed your app with `app:dev`, use `app:build` to compile it int```bash filename="Terminal"# Build the app (output goes to .twenty/output/)-yarn twenty app:build+yarn twenty build# Build and create a tarball (.tgz) for distribution-yarn twenty app:build --tarball+yarn twenty build --tarball```The build process:@@ -1323,10 +1323,10 @@ Use `app:publish` to distribute your app — either to the npm registry or direc```bash filename="Terminal"# Publish to npm (requires npm login)-yarn twenty app:publish+yarn twenty publish# Publish with a dist-tag (e.g. beta, next)-yarn twenty app:publish --tag beta+yarn twenty publish --tag beta```This builds the app and runs `npm publish` from the `.twenty/output/` directory. The published package can then be installed from the Twenty marketplace by any workspace.@@ -1335,7 +1335,7 @@ This builds the app and runs `npm publish` from the `.twenty/output/` directory.```bash filename="Terminal"# Publish directly to a Twenty server-yarn twenty app:publish --server https://app.twenty.com+yarn twenty publish --server https://app.twenty.com```This builds the app with a tarball, uploads it to the server via the `uploadAppTarball` GraphQL mutation, and triggers installation in one step. This is useful for private deployments or testing against a specific server.@@ -1399,13 +1399,13 @@ Then add a `twenty` script:}```-Now you can run all commands via `yarn twenty <command>`, e.g. `yarn twenty app:dev`, `yarn twenty help`, etc.+Now you can run all commands via `yarn twenty <command>`, e.g. `yarn twenty dev`, `yarn twenty help`, etc.## Troubleshooting- Authentication errors: run `yarn twenty auth:login` and ensure your API key has the required permissions.- Cannot connect to server: verify the API URL and that the Twenty server is reachable.-- Types or client missing/outdated: restart `yarn twenty app:dev` — it auto-generates the typed client.-- Dev mode not syncing: ensure `yarn twenty app:dev` is running and that changes are not ignored by your environment.+- Types or client missing/outdated: restart `yarn twenty dev` — it auto-generates the typed client.+- Dev mode not syncing: ensure `yarn twenty dev` is running and that changes are not ignored by your environment.Discord Help Channel: https://discord.com/channels/1130383047699738754/1130386664812982322diff --git a/packages/twenty-front/src/pages/settings/applications/tabs/SettingsApplicationsDeveloperTab.tsx b/packages/twenty-front/src/pages/settings/applications/tabs/SettingsApplicationsDeveloperTab.tsxindex 1478fcef2dc..7d6f24bd6e9 100644--- a/packages/twenty-front/src/pages/settings/applications/tabs/SettingsApplicationsDeveloperTab.tsx+++ b/packages/twenty-front/src/pages/settings/applications/tabs/SettingsApplicationsDeveloperTab.tsx@@ -100,7 +100,7 @@ export const SettingsApplicationsDeveloperTab = () => {const syncCommands = [// oxlint-disable-next-line lingui/no-unlocalized-strings- 'yarn twenty app:dev',+ 'yarn twenty dev',];const syncCopyButton = (