codebuff/npm-app/src/cli-definitions.ts at 99e5ee0d8326e736781e34af073c2695787b2d50 · CodebuffAI/codebuff · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
export interface CliParam {
  flags: string
  description: string
  menuDescription?: string
  menuDetails?: string[]
  hidden?: boolean
}

export const cliArguments: CliParam[] = [
  {
    flags: '[initial-prompt...]',
    description: 'Initial prompt to send',
    menuDescription: 'Initial prompt to send to Codebuff',
  },
]

export const cliOptions: CliParam[] = [
  {
    flags: '--create <template> [name]',
    description: 'Create new project from template',
    menuDetails: [
      'Available templates: nextjs, convex, vite, remix, node-cli,',
      'python-cli, chrome-extension',
      'See all: https://github.com/CodebuffAI/codebuff-community',
    ],
  },
  {
    flags: '--init',
    description:
      'Initialize codebuff on this project for a smoother experience',
    menuDescription: 'Initialize Codebuff for the project',
  },
  {
    flags: '--agent <agent-id>',
    description:
      'Specify which agent to invoke (e.g., "file-picker", "reviewer", "base")',
    menuDescription: 'Invoke a specific agent by ID',
    hidden: false,
  },
  {
    flags: '--params <json>',
    description: 'JSON parameters to pass to the agent',
    menuDescription: 'JSON parameters for the agent',
    hidden: false,
  },
  {
    flags: '--model <model>',
    description:
      'Experimental: Specify the main model to use for the agent ("sonnet-3.6", "sonnet-3.7", "gpt-4.1", "gemini-2.5-pro", "o4-mini", "o3"). Be aware codebuff might not work as well with non-default models.',
    menuDescription: 'Specify main LLM (e.g., "sonnet-3.7") (Experimental)',
    hidden: true,
  },
  {
    flags: '--lite',
    description: 'Use budget models & fetch fewer files',
    menuDescription: 'Use budget models & fetch fewer files (faster)',
    hidden: false,
  },
  {
    flags: '--max',
    description: 'Use higher quality models and fetch more files',
    menuDescription:
      'Use higher quality models and fetch more files (thorough)',
    hidden: false,
  },
  {
    flags: '--ask',
    description: "Start in ask mode (won't change code)",
    menuDescription: "Start in ask mode (won't change code)",
    hidden: false,
  },
  {
    flags: '--experimental',
    description: 'Use cutting-edge experimental features and models',
    hidden: true,
  },
  {
    flags: '--print, -p',
    description:
      'Print-only mode: run until first response completes then exit (requires prompt or params)',
    menuDescription: 'Print-only mode: run once then exit',
    hidden: false,
  },
  {
    flags: '--cwd <directory>',
    description: 'Set the working directory (default: current directory)',
    menuDescription: 'Set the working directory',
    hidden: false,
  },
  {
    flags: '--trace',
    description: 'Log all subagent messages to .agents/traces/*.log files',
    menuDescription: 'Log subagent messages to trace files',
    hidden: false,
  },
  {
    flags: '--force',
    description: 'Force overwrite existing shims',
    hidden: true,
  },
]