Skip to content

The open alternative to Salesforce, designed for AI.

1.7 KB
Raw Blame
import { HELP_GROUP } from '@/catalog/constants/help-group.constant';
import { type CommandTopicDefinition } from '@/catalog/types/command-topic-definition.type';
import { AUTH_LOGIN_COMMAND_DEFINITION } from '@/commands/auth/login/auth-login.command-definition';

export const COMMAND_TOPICS: CommandTopicDefinition[] = [
  {
    path: ['local'],
    description: 'Run a local Twenty development environment',
    helpGroup: HELP_GROUP.APP,
    helpHint:
      'Runs Twenty, including its web UI, worker and databases. Requires a local Docker installation. Sign in afterward with twenty auth login.',
  },
  {
    path: ['app'],
    description: 'Create, develop and manage applications',
    helpGroup: HELP_GROUP.APP,
  },
  {
    path: ['app', 'translations'],
    description: 'Manage app translation catalogs',
  },
  {
    path: ['data'],
    description: 'Read workspace records',
    helpGroup: HELP_GROUP.WORKSPACE,
  },
  {
    path: ['auth'],
    description: 'Sign in and manage credentials',
    helpGroup: HELP_GROUP.WORKSPACE,
  },
  {
    path: ['remote'],
    description: 'Manage saved workspace connections',
    helpGroup: HELP_GROUP.WORKSPACE,
    helpHint:
      'Add a remote using browser sign-in or an API key. See: twenty auth login --help',
    examples: AUTH_LOGIN_COMMAND_DEFINITION.examples,
  },
  {
    path: ['metadata'],
    description: 'Inspect the data model',
    helpGroup: HELP_GROUP.WORKSPACE,
  },
  {
    path: ['metadata', 'object'],
    description: 'Objects',
  },
  {
    path: ['metadata', 'field'],
    description: 'Fields',
  },
  {
    path: ['api'],
    description: 'Send raw REST and GraphQL requests',
    helpGroup: HELP_GROUP.WORKSPACE,
  },
];