Skip to content

The open alternative to Salesforce, designed for AI.

Add a CLI tab to Developers settings and move app creation to the standalone CLI (#28498)

Félix Malfait7348af15ca30
diff --git a/packages/twenty-docs/developers/extend/apps/operations/cli.mdx b/packages/twenty-docs/developers/extend/apps/operations/cli.mdx
index 7e0fbb16e87..af82e4e985a 100644
--- a/packages/twenty-docs/developers/extend/apps/operations/cli.mdx
+++ b/packages/twenty-docs/developers/extend/apps/operations/cli.mdx
@@ -1,132 +1,171 @@
---
title: CLI
-description: yarn twenty commands for executing functions, streaming logs, managing app installations, and switching remotes.
+description: Sign in to a workspace, explore its data and build apps from your terminal with the twenty CLI.
icon: "terminal"
---
-The `yarn twenty` CLI is your interface to everything app-related. Full command list:
+The `twenty` CLI connects to Twenty workspaces from your terminal. Use it to inspect metadata, read records, send API requests, and create, sync and debug apps. It needs **Node.js 24.5 or later**.
-| Command | What it does | Documented in |
-|---------|--------------|---------------|
-| `dev` | Watch source files and live-sync changes | [Quick Start](/developers/extend/apps/getting-started/quick-start) |
-| `plan` | Preview metadata changes without applying them | [Syncing & recovery](/developers/extend/apps/operations/sync-and-recovery#previewing-changes-plan) |
-| `apply` | Apply metadata changes after showing the plan | [Syncing & recovery](/developers/extend/apps/operations/sync-and-recovery) |
-| `pull` | **Experimental.** Write the installed application back to local source files | [Syncing & recovery](/developers/extend/apps/operations/sync-and-recovery#pulling-an-installed-app-back-to-source) |
-| `dev:build` | Compile the app and generate the API client (`--tarball` to pack a `.tgz`) | [Publishing](/developers/extend/apps/operations/publishing) |
-| `dev:typecheck` | Run TypeScript type checking | [Testing](/developers/extend/apps/operations/testing) |
-| `dev:add` | Scaffold a new entity | [Scaffolding](/developers/extend/apps/getting-started/scaffolding) |
-| `dev:generate-client` | Regenerate the typed API client | this page |
-| `dev:function:exec` / `dev:function:logs` | Execute functions and stream their logs | this page |
-| `dev:translations-extract` | Extract translatable strings into `locales/` catalogs | [Translations](/developers/extend/apps/operations/translations) |
-| `dev:catalog-sync` | Trigger a marketplace catalog sync | [Publishing](/developers/extend/apps/operations/publishing#how-marketplace-discovery-works) |
-| `app:publish` / `app:install` / `app:uninstall` | Release lifecycle | [Publishing](/developers/extend/apps/operations/publishing) and this page |
-| `docker:*` | Manage the local Twenty server container | [Local Server](/developers/extend/apps/getting-started/local-server) |
-| `remote:*` | Manage server connections | this page |
+## Running the CLI
-Every command accepts `-r, --remote <name>` to target a specific remote instead of the default one.
+Run any command through `npx`, without installing anything:
-## Executing functions (`yarn twenty dev:function:exec`)
+```bash filename="Terminal"
+npx twenty@latest --version
+```
-Run a logic function manually without triggering it via HTTP, cron, or database event:
+Or install it once globally and call `twenty` directly:
```bash filename="Terminal"
-# Execute by function name
-yarn twenty dev:function:exec -n create-new-post-card
+npm install -g twenty
+twenty --version
+```
-# Execute by universalIdentifier
-yarn twenty dev:function:exec -u e56d363b-0bdc-4d8a-a393-6f0d1c75bdcf
+<Warning>
+Inside an app project, use `npx twenty@latest`, not `npx twenty`. Apps depend on `twenty-sdk`, which still ships an older `twenty` binary, and `npx twenty` runs that local binary instead of this CLI.
+</Warning>
-# Pass a JSON payload
-yarn twenty dev:function:exec -n create-new-post-card -p '{"name": "Hello"}'
+The examples below use `twenty`. Prefix them with `npx twenty@latest` if you did not install it globally. Run `twenty commands` for the full command list and `twenty <command> --help` for the options of one command.
-# Execute the install and uninstall hooks
-yarn twenty dev:function:exec --postInstall
-yarn twenty dev:function:exec --preInstall
-yarn twenty dev:function:exec --uninstall
-```
+| Command | What it does |
+|---------|--------------|
+| `auth` | Sign in, check and remove credentials |
+| `remote` | List, select, rename and remove saved workspace connections |
+| `metadata` | Inspect objects and fields |
+| `data` | List and read records |
+| `api` | Send raw REST or GraphQL requests |
+| `open` | Open the workspace in your browser |
+| `app` | Create, build, sync, debug and uninstall apps |
+| `doctor` | Diagnose the CLI, app SDK and workspace connection |
+
+Every command that talks to a workspace accepts `--remote <name>` to target a saved connection other than the default one, and `--json` for structured output.
-## Viewing function logs (`yarn twenty dev:function:logs`)
+## Connecting to a workspace
-Stream execution logs for your app's logic functions:
+Sign in with your browser. `--use` makes this connection the default one:
```bash filename="Terminal"
-# Stream all function logs
-yarn twenty dev:function:logs
+twenty auth login --url https://acme.twenty.com --use
+twenty auth status
+```
-# Filter by function name
-yarn twenty dev:function:logs -n create-new-post-card
+Use your workspace's address, or the server's address for a local setup: `http://localhost:2020` for the [local Docker server](/developers/extend/apps/getting-started/local-server), `http://localhost:3000` for a source checkout. You can copy the exact command from **Settings > Developers > CLI**. Browser sign-in needs Twenty 2.42 or later.
-# Filter by universalIdentifier
-yarn twenty dev:function:logs -u e56d363b-0bdc-4d8a-a393-6f0d1c75bdcf
+Keep several connections by naming them:
+
+```bash filename="Terminal"
+twenty auth login --url http://localhost:2020 --name local
+twenty remote list
+twenty remote use local
```
-<Note>
-This is different from `yarn twenty docker:logs`, which shows the Docker container logs. `yarn twenty dev:function:logs` shows your app's function execution logs from the Twenty server.
-</Note>
+In CI or scripts, pipe an API key instead of signing in with the browser:
+
+```bash filename="Terminal"
+printf '%s' "$TWENTY_API_KEY" | twenty auth login --with-token --url https://acme.twenty.com --name ci
+```
-## Generating the typed client (`yarn twenty dev:generate-client`)
+You can also set `TWENTY_API_URL` and `TWENTY_API_KEY` for a single run without saving anything. Saved connections live in `~/.twenty/config.json`.
-Regenerate the typed API client (`twenty-client-sdk`) for your app from the active remote. The client is scoped to the application declared in your manifest, so the command reads the build output: run `yarn twenty dev:build` (or `yarn twenty dev`) first.
+## Exploring your data
```bash filename="Terminal"
-# Connect to the Twenty instance to generate the client from
-yarn twenty remote:add
+# Objects and fields
+twenty metadata object list
+twenty metadata field list companies
+
+# Records
+twenty data list companies --limit 5
+twenty data list companies --filter 'employees[gte]:5000' --order-by 'employees[DescNullsLast]'
+twenty data get people <id>
+
+# Raw API requests
+twenty api rest '/rest/companies?limit=5'
+twenty api graphql --query '{ companies(first: 2) { edges { node { name } } } }'
+
+# Open the workspace, or a page inside it
+twenty open
+twenty open settings/developers
+```
+
+Object names are exact API names, singular or plural (`company` or `companies`). Raw API writes run without a confirmation step, and your permissions in the workspace still apply.
-# Build the app so the manifest exists
-yarn twenty dev:build
+## Building an app
-# Generate the typed client into node_modules/twenty-client-sdk
-yarn twenty dev:generate-client
+```bash filename="Terminal"
+npx twenty@latest app init my-app
+cd my-app
+yarn install
+npx twenty@latest app apply --create
+npx twenty@latest app dev
```
-Then import the client in your code:
+- `app init` writes a new project from the template. It does not install dependencies or contact a workspace.
+- `app apply --create` builds the app, registers it in the workspace, installs it and syncs its metadata.
+- `app dev` watches your source and syncs every successful build.
-```typescript
-import { CoreApiClient } from 'twenty-client-sdk/core';
-```
+Other app commands:
-Re-run the command whenever your data model changes to refresh the generated types.
+| Command | What it does |
+|---------|--------------|
+| `app add` | Scaffold an object, field, logic function or other entity |
+| `app build` / `app typecheck` | Build or typecheck the app locally |
+| `app plan` | Preview the metadata changes an apply would make |
+| `app apply` | Build, upload and sync the app |
+| `app generate-client` | Regenerate the typed API client without syncing |
+| `app pull` | Write the installed app's metadata back to local source |
+| `app translations extract` | Extract translatable strings into `locales/` catalogs |
+| `app publish` | Publish the app to npm or to a private Twenty registry |
+| `app install` | Install an already registered app package in the workspace |
+| `app uninstall` | Remove the app and everything it owns from the workspace |
-<Note>
-The client is generated inside `node_modules`, so it is not committed with your code. Run `yarn twenty dev:build` then `yarn twenty dev:generate-client` after every install (for example in a `postinstall` script or in CI).
-</Note>
+Definitions missing from your source are deleted from the workspace by default. Pass `--no-delete` to keep them. Deleting objects or fields also deletes their data, so it requires confirmation. See [Syncing & recovery](/developers/extend/apps/operations/sync-and-recovery) for details.
-## Uninstalling an app (`yarn twenty app:uninstall`)
+## Executing functions
-Remove your app from the active workspace:
+Run a deployed logic function without triggering it through a route, a cron or a database event. Sync your local changes with `app apply` or `app dev` first.
```bash filename="Terminal"
-yarn twenty app:uninstall
+twenty app exec --name create-new-post-card
+twenty app exec --name create-new-post-card --payload '{"name": "Hello"}'
-# Skip the confirmation prompt
-yarn twenty app:uninstall --yes
+# Install and uninstall hooks
+twenty app exec --post-install
+twenty app exec --pre-install
+twenty app exec --uninstall-hook
```
-## Managing remotes
+Executing functions requires a browser sign-in. API keys cannot execute them.
+
+## Watching function logs
-A **remote** is a Twenty server that your app connects to. During setup, the scaffolder creates one for you automatically. You can add more remotes or switch between them at any time.
+Stream the output of your app's logic functions as executions finish:
```bash filename="Terminal"
-# Add a new remote (opens a browser for OAuth login)
-yarn twenty remote:add
+twenty app logs
+twenty app logs --name create-new-post-card
+```
-# Connect to a local Twenty server (auto-detects port 2020 or 3000)
-yarn twenty remote:add --local
+It only shows new executions, not past ones.
-# Add a remote non-interactively (useful for CI)
-yarn twenty remote:add --url https://your-twenty-server.com --api-key $TWENTY_API_KEY --as my-remote
+## Uninstalling an app
-# List all configured remotes
-yarn twenty remote:list
+```bash filename="Terminal"
+twenty app uninstall
+twenty app uninstall --yes
+```
-# Set the active remote
-yarn twenty remote:use <name>
+This runs the app's uninstall hook and deletes everything it owns, including its objects, fields and their data. The app stays registered, so `twenty app apply` can install it again.
-# Check that the active remote's authentication is still valid
-yarn twenty remote:status
+## Diagnosing problems
-# Remove a remote
-yarn twenty remote:remove <name>
+```bash filename="Terminal"
+twenty doctor
+twenty doctor --offline
```
-Your credentials are stored in `~/.twenty/config.json`.
+`doctor` checks your Node version, which `twenty` binary is on your `PATH`, your saved connections and the app SDK, then reports what to fix.
+
+## Full reference
+
+The [command reference](https://github.com/twentyhq/twenty/blob/main/packages/twenty-cli/docs/commands.md) covers every flag, permission, output format and exit code.
diff --git a/packages/twenty-docs/developers/extend/apps/operations/overview.mdx b/packages/twenty-docs/developers/extend/apps/operations/overview.mdx
index 727bb06aa74..e06f243cabb 100644
--- a/packages/twenty-docs/developers/extend/apps/operations/overview.mdx
+++ b/packages/twenty-docs/developers/extend/apps/operations/overview.mdx
@@ -18,7 +18,7 @@ The **operations layer** is everything you do *to* your app rather than *with* i
<CardGroup cols={2}>
<Card title="CLI" icon="terminal" href="/developers/extend/apps/operations/cli">
- `yarn twenty` reference — exec, logs, uninstall, remotes.
+ Sign in, explore data, build apps, exec, logs and uninstall with the `twenty` CLI.
</Card>
<Card title="Syncing & recovery" icon="compass" href="/developers/extend/apps/operations/sync-and-recovery">
Which command when, reading the sync diff, and a recovery ladder.
diff --git a/packages/twenty-docs/snippets/ui/generated/icon/catalog.mdx b/packages/twenty-docs/snippets/ui/generated/icon/catalog.mdx
index 6846066fc1a..d13737c16f9 100644
--- a/packages/twenty-docs/snippets/ui/generated/icon/catalog.mdx
+++ b/packages/twenty-docs/snippets/ui/generated/icon/catalog.mdx
@@ -428,6 +428,7 @@ Supported props: `color`, `size`, `stroke`, `title`. Native SVG attributes and r
- `IconTarget`
- `IconTargetArrow`
- `IconTerminal`
+- `IconTerminal2`
- `IconTestPipe`
- `IconTextCaption`
- `IconTextSize`
diff --git a/packages/twenty-front/src/modules/settings/developers/constants/SettingsDevelopersTabs.ts b/packages/twenty-front/src/modules/settings/developers/constants/SettingsDevelopersTabs.ts
index cf89adaa9f3..4e67ad27bdf 100644
--- a/packages/twenty-front/src/modules/settings/developers/constants/SettingsDevelopersTabs.ts
+++ b/packages/twenty-front/src/modules/settings/developers/constants/SettingsDevelopersTabs.ts
@@ -4,5 +4,6 @@ export const SETTINGS_DEVELOPERS_TABS = {
API: 'api',
WEBHOOKS: 'webhooks',
APPS: 'apps',
+ CLI: 'cli',
},
} as const;
diff --git a/packages/twenty-front/src/modules/settings/developers/constants/TwentyCliCreateAppCommands.ts b/packages/twenty-front/src/modules/settings/developers/constants/TwentyCliCreateAppCommands.ts
new file mode 100644
index 00000000000..239456a975c
--- /dev/null
+++ b/packages/twenty-front/src/modules/settings/developers/constants/TwentyCliCreateAppCommands.ts
@@ -0,0 +1,10 @@
+import { doNotTranslate } from 'twenty-shared/i18n';
+
+// A bare `npx twenty` would run the deprecated binary from the app's twenty-sdk
+export const TWENTY_CLI_CREATE_APP_COMMANDS = doNotTranslate([
+ 'npx twenty@latest app init my-app',
+ 'cd my-app',
+ 'yarn install',
+ 'npx twenty@latest app apply --create',
+ 'npx twenty@latest app dev',
+]);
diff --git a/packages/twenty-front/src/modules/settings/developers/constants/TwentyCliLoginCommand.ts b/packages/twenty-front/src/modules/settings/developers/constants/TwentyCliLoginCommand.ts
new file mode 100644
index 00000000000..d0bf570bac4
--- /dev/null
+++ b/packages/twenty-front/src/modules/settings/developers/constants/TwentyCliLoginCommand.ts
@@ -0,0 +1,7 @@
+import { doNotTranslate } from 'twenty-shared/i18n';
+
+import { REACT_APP_SERVER_BASE_URL } from '~/config';
+
+export const TWENTY_CLI_LOGIN_COMMAND = doNotTranslate(
+ `npx twenty@latest auth login --url ${REACT_APP_SERVER_BASE_URL} --use`,
+);
diff --git a/packages/twenty-front/src/pages/settings/developers/SettingsDevelopers.tsx b/packages/twenty-front/src/pages/settings/developers/SettingsDevelopers.tsx
index 78bfcba87df..153436a3237 100644
--- a/packages/twenty-front/src/pages/settings/developers/SettingsDevelopers.tsx
+++ b/packages/twenty-front/src/pages/settings/developers/SettingsDevelopers.tsx
@@ -21,6 +21,7 @@ import {
IconApps,
IconPlus,
IconSparkle2,
+ IconTerminal2,
IconWebhook,
} from 'twenty-ui/icon';
import { MOBILE_VIEWPORT, themeCssVariables } from 'twenty-ui/theme';
@@ -29,6 +30,7 @@ import AppsCoverDark from '~/pages/settings/applications/assets/cover-dark.png';
import AppsCoverLight from '~/pages/settings/applications/assets/cover-light.png';
import { SettingsDevelopersClaimErrorTabEffect } from '~/pages/settings/developers/components/SettingsDevelopersClaimErrorTabEffect';
import { SettingsDevelopersAppsTab } from '~/pages/settings/developers/tabs/SettingsDevelopersAppsTab';
+import { SettingsDevelopersCliTab } from '~/pages/settings/developers/tabs/SettingsDevelopersCliTab';
type TabKey =
(typeof SETTINGS_DEVELOPERS_TABS.TABS_IDS)[keyof typeof SETTINGS_DEVELOPERS_TABS.TABS_IDS];
@@ -78,6 +80,11 @@ export const SettingsDevelopers = () => {
title: t`Apps`,
Icon: IconApps,
},
+ {
+ id: SETTINGS_DEVELOPERS_TABS.TABS_IDS.CLI,
+ title: t`CLI`,
+ Icon: IconTerminal2,
+ },
];
const activeTab: TabKey =
@@ -87,6 +94,7 @@ export const SettingsDevelopers = () => {
) as TabKey) ?? SETTINGS_DEVELOPERS_TABS.TABS_IDS.API;
const isAppsTab = activeTab === SETTINGS_DEVELOPERS_TABS.TABS_IDS.APPS;
+ const isCliTab = activeTab === SETTINGS_DEVELOPERS_TABS.TABS_IDS.CLI;
return (
<SettingsPageLayout
@@ -117,7 +125,7 @@ export const SettingsDevelopers = () => {
darkSrc={isAppsTab ? AppsCoverDark : PlaygroundCoverDark}
instanceIdPrefix={SETTINGS_DEVELOPERS_HERO_INSTANCE_ID_PREFIX}
tabs={
- isAppsTab
+ isAppsTab || isCliTab
? []
: [
{
@@ -186,6 +194,8 @@ export const SettingsDevelopers = () => {
)}
{isAppsTab && <SettingsDevelopersAppsTab />}
+
+ {isCliTab && <SettingsDevelopersCliTab />}
</SettingsPageContainer>
</SettingsPageLayout>
);
diff --git a/packages/twenty-front/src/pages/settings/developers/tabs/SettingsDevelopersAppsTab.tsx b/packages/twenty-front/src/pages/settings/developers/tabs/SettingsDevelopersAppsTab.tsx
index 9a649ed9ed2..ae805f1a4bb 100644
--- a/packages/twenty-front/src/pages/settings/developers/tabs/SettingsDevelopersAppsTab.tsx
+++ b/packages/twenty-front/src/pages/settings/developers/tabs/SettingsDevelopersAppsTab.tsx
@@ -1,5 +1,7 @@
import { useRefetchOnApplicationRegistrationChange } from '@/applications/hooks/useRefetchOnApplicationRegistrationChange';
import { currentWorkspaceMemberState } from '@/auth/states/currentWorkspaceMemberState';
+import { TWENTY_CLI_CREATE_APP_COMMANDS } from '@/settings/developers/constants/TwentyCliCreateAppCommands';
+import { TWENTY_CLI_LOGIN_COMMAND } from '@/settings/developers/constants/TwentyCliLoginCommand';
import { useHasPermissionFlag } from '@/settings/roles/hooks/useHasPermissionFlag';
import { getDocumentationUrl } from '@/support/utils/getDocumentationUrl';
import { Table } from '@/ui/layout/table/components/Table';
@@ -12,7 +14,6 @@ import { useLingui } from '@lingui/react/macro';
import { useState } from 'react';
import { SettingsPath } from 'twenty-shared/types';
import { getSettingsPath } from 'twenty-shared/utils';
-import { doNotTranslate } from 'twenty-shared/i18n';
import { CommandBlock } from 'twenty-ui/components/data-display';
import { SearchInput } from 'twenty-ui/components/input';
import { Section } from 'twenty-ui/components/layout';
@@ -67,10 +68,10 @@ export const SettingsDevelopersAppsTab = () => {
const registrations: ApplicationRegistrationListItemFragment[] =
data?.findManyApplicationRegistrations ?? [];
- const createCommands = doNotTranslate([
- 'npx create-twenty-app@latest my-twenty-app',
- 'cd my-twenty-app',
- ]);
+ const createCommands = [
+ TWENTY_CLI_LOGIN_COMMAND,
+ ...TWENTY_CLI_CREATE_APP_COMMANDS,
+ ];
const createCopyButton = (
<Button
@@ -117,8 +118,6 @@ export const SettingsDevelopersAppsTab = () => {
</StyledButtonContainer>
</Section.Root>
- {canClaimApplications && <SettingsClaimApplicationSection />}
-
{registrations.length > 0 && (
<Section.Root>
<Section.Header
@@ -163,6 +162,8 @@ export const SettingsDevelopersAppsTab = () => {
</Table>
</Section.Root>
)}
+
+ {canClaimApplications && <SettingsClaimApplicationSection />}
</>
);
};
diff --git a/packages/twenty-front/src/pages/settings/developers/tabs/SettingsDevelopersCliTab.tsx b/packages/twenty-front/src/pages/settings/developers/tabs/SettingsDevelopersCliTab.tsx
new file mode 100644
index 00000000000..3362c0d8d28
--- /dev/null
+++ b/packages/twenty-front/src/pages/settings/developers/tabs/SettingsDevelopersCliTab.tsx
@@ -0,0 +1,121 @@
+import { currentWorkspaceMemberState } from '@/auth/states/currentWorkspaceMemberState';
+import { TWENTY_CLI_CREATE_APP_COMMANDS } from '@/settings/developers/constants/TwentyCliCreateAppCommands';
+import { TWENTY_CLI_LOGIN_COMMAND } from '@/settings/developers/constants/TwentyCliLoginCommand';
+import { getDocumentationUrl } from '@/support/utils/getDocumentationUrl';
+import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
+import { styled } from '@linaria/react';
+import { useLingui } from '@lingui/react/macro';
+import { type ReactNode } from 'react';
+import { doNotTranslate } from 'twenty-shared/i18n';
+import { CommandBlock } from 'twenty-ui/components/data-display';
+import { Section } from 'twenty-ui/components/layout';
+import { IconArrowUpRight, IconCopy } from 'twenty-ui/icon';
+import { Button } from 'twenty-ui/primitives/input';
+import { themeCssVariables } from 'twenty-ui/theme';
+import { useCopyToClipboard } from '~/hooks/useCopyToClipboard';
+import { openUrlInNewTab } from '~/utils/openUrlInNewTab';
+
+const CLI_COMMAND_REFERENCE_URL =
+ 'https://github.com/twentyhq/twenty/blob/main/packages/twenty-cli/docs/commands.md';
+
+const StyledButtonContainer = styled.div`
+ display: flex;
+ gap: ${themeCssVariables.spacing[2]};
+ justify-content: flex-end;
+ margin-top: ${themeCssVariables.spacing[2]};
+`;
+
+type SettingsDevelopersCliCommandSectionProps = {
+ title: string;
+ description: string;
+ commands: string[];
+ children?: ReactNode;
+};
+
+const SettingsDevelopersCliCommandSection = ({
+ title,
+ description,
+ commands,
+ children,
+}: SettingsDevelopersCliCommandSectionProps) => {
+ const { t } = useLingui();
+ const { copyToClipboard } = useCopyToClipboard();
+
+ return (
+ <Section.Root>
+ <Section.Header title={title} description={description} />
+ <CommandBlock
+ commands={commands}
+ actions={
+ <Button
+ onClick={() =>
+ copyToClipboard(
+ commands.join('\n'),
+ t`Commands copied to clipboard`,
+ )
+ }
+ aria-label={t`Copy commands`}
+ startIcon={<IconCopy />}
+ />
+ }
+ />
+ {children}
+ </Section.Root>
+ );
+};
+
+export const SettingsDevelopersCliTab = () => {
+ const { t } = useLingui();
+ const currentWorkspaceMember = useAtomStateValue(currentWorkspaceMemberState);
+
+ return (
+ <>
+ <SettingsDevelopersCliCommandSection
+ title={t`Connect to this workspace`}
+ description={t`Sign in from your browser and make this workspace your default connection. Requires Node.js 24.5 or later.`}
+ commands={doNotTranslate([
+ TWENTY_CLI_LOGIN_COMMAND,
+ 'npx twenty@latest auth status',
+ ])}
+ />
+
+ <SettingsDevelopersCliCommandSection
+ title={t`Explore your data`}
+ description={t`Inspect the data model, query records and send raw API requests.`}
+ commands={doNotTranslate([
+ 'npx twenty@latest metadata object list',
+ 'npx twenty@latest data list companies --limit 5',
+ "npx twenty@latest api rest '/rest/people?limit=5'",
+ ])}
+ />
+
+ <SettingsDevelopersCliCommandSection
+ title={t`Build an app`}
+ description={t`Scaffold an app, register it in this workspace and sync your changes as you code.`}
+ commands={TWENTY_CLI_CREATE_APP_COMMANDS}
+ >
+ <StyledButtonContainer>
+ <Button
+ startIcon={<IconArrowUpRight />}
+ size="sm"
+ variant="ghost"
+ onClick={() => openUrlInNewTab(CLI_COMMAND_REFERENCE_URL)}
+ >{t`Command reference`}</Button>
+ <Button
+ startIcon={<IconArrowUpRight />}
+ size="sm"
+ variant="outline"
+ onClick={() =>
+ openUrlInNewTab(
+ getDocumentationUrl({
+ locale: currentWorkspaceMember?.locale,
+ path: '/developers/extend/apps/operations/cli',
+ }),
+ )
+ }
+ >{t`Read documentation`}</Button>
+ </StyledButtonContainer>
+ </SettingsDevelopersCliCommandSection>
+ </>
+ );
+};
diff --git a/packages/twenty-ui/docs/public-exports.json b/packages/twenty-ui/docs/public-exports.json
index 9df325e94c6..72ba77c48e1 100644
--- a/packages/twenty-ui/docs/public-exports.json
+++ b/packages/twenty-ui/docs/public-exports.json
@@ -627,6 +627,7 @@
"IconTarget": "icon/components/TablerIcons",
"IconTargetArrow": "icon/components/TablerIcons",
"IconTerminal": "icon/components/TablerIcons",
+ "IconTerminal2": "icon/components/TablerIcons",
"IconTestPipe": "icon/components/TablerIcons",
"IconTextCaption": "icon/components/TablerIcons",
"IconTextSize": "icon/components/TablerIcons",
diff --git a/packages/twenty-ui/generated/icons.docs.json b/packages/twenty-ui/generated/icons.docs.json
index 571e0e5445c..e7dcef5ef13 100644
--- a/packages/twenty-ui/generated/icons.docs.json
+++ b/packages/twenty-ui/generated/icons.docs.json
@@ -414,6 +414,7 @@
"IconTarget",
"IconTargetArrow",
"IconTerminal",
+ "IconTerminal2",
"IconTestPipe",
"IconTextCaption",
"IconTextSize",
diff --git a/packages/twenty-ui/src/icon/components/TablerIcons.ts b/packages/twenty-ui/src/icon/components/TablerIcons.ts
index 8c651557c10..7d1eae7070d 100644
--- a/packages/twenty-ui/src/icon/components/TablerIcons.ts
+++ b/packages/twenty-ui/src/icon/components/TablerIcons.ts
@@ -413,6 +413,7 @@ export {
IconTarget,
IconTargetArrow,
IconTerminal,
+ IconTerminal2,
IconTestPipe,
IconTextCaption,
IconTextSize,
diff --git a/packages/twenty-ui/src/icon/constants/TwentyIconDictionary.ts b/packages/twenty-ui/src/icon/constants/TwentyIconDictionary.ts
index 531dabf792d..789c7c3db8c 100644
--- a/packages/twenty-ui/src/icon/constants/TwentyIconDictionary.ts
+++ b/packages/twenty-ui/src/icon/constants/TwentyIconDictionary.ts
@@ -476,6 +476,17 @@ export const TWENTY_ICON_DICTIONARY = [
avoidWhen:
'Representing an API, webhook, or app individually, or generic source code.',
},
+ {
+ key: 'cli',
+ label: 'CLI',
+ category: 'platform',
+ iconName: 'IconTerminal2',
+ tablerName: 'terminal-2',
+ keywords: ['CLI', 'command line', 'terminal', 'twenty command'],
+ useWhen: 'Representing the Twenty command line tool or its commands.',
+ avoidWhen:
+ 'Representing execution logs, runtime output, or the command menu.',
+ },
{
key: 'api-key',
label: 'API Key',
diff --git a/packages/twenty-ui/src/icon/icon-dictionary.md b/packages/twenty-ui/src/icon/icon-dictionary.md
index 82358336cb6..6436b5359bb 100644
--- a/packages/twenty-ui/src/icon/icon-dictionary.md
+++ b/packages/twenty-ui/src/icon/icon-dictionary.md
@@ -100,6 +100,7 @@ import { IconHierarchy } from 'twenty-ui/icon';
| --- | --- | --- | --- | --- | --- |
| API | `IconApi` | `api` | Representing APIs, API access, or API configuration. | Representing MCP, webhooks, or external-service integrations. | API, REST, GraphQL, API key |
| Developers | `IconCode` | `code` | Representing the Developers settings area for API keys, webhooks, and apps. | Representing an API, webhook, or app individually, or generic source code. | developers, developer settings, API keys and webhooks, app development |
+| CLI | `IconTerminal2` | `terminal-2` | Representing the Twenty command line tool or its commands. | Representing execution logs, runtime output, or the command menu. | CLI, command line, terminal, twenty command |
| API Key | `IconKey` | `key` | Representing an API key or API credential. | Representing APIs generally, security settings, or permissions. | API key, API credential, access token, secret key |
| Webhook | `IconWebhook` | `webhook` | Representing webhooks, webhook endpoints, or webhook events. | Representing a generic API, integration, or workflow action. | webhook, event callback, HTTP event, webhook endpoint |
| Integration / Connection | `IconPlug` | `plug` | Representing an integration or connection to an external service. | Representing an app, API, MCP, or connected email account. | integration, connection, external service, provider |
diff --git a/packages/twenty-ui/src/icon/index.ts b/packages/twenty-ui/src/icon/index.ts
index 562dad567dc..511538c24a1 100644
--- a/packages/twenty-ui/src/icon/index.ts
+++ b/packages/twenty-ui/src/icon/index.ts
@@ -469,6 +469,7 @@ export {
IconTarget,
IconTargetArrow,
IconTerminal,
+ IconTerminal2,
IconTestPipe,
IconTextCaption,
IconTextSize,