cline.1 9.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331
  1. .\" Automatically generated by Pandoc 3.8.2
  2. .\"
  3. .TH "CLINE" "1" "January 2025" "Cline CLI 1.0" "User Commands"
  4. .SH NAME
  5. cline \- orchestrate and interact with Cline AI coding agents
  6. .SH SYNOPSIS
  7. \f[B]cline\f[R] [\f[I]prompt\f[R]] [\f[I]options\f[R]]
  8. .PP
  9. \f[B]cline\f[R] \f[I]command\f[R] [\f[I]subcommand\f[R]]
  10. [\f[I]options\f[R]] [\f[I]arguments\f[R]]
  11. .SH DESCRIPTION
  12. Try: cat README.md | cline \(lqSummarize this for me:\(rq
  13. .PP
  14. \f[B]cline\f[R] is a command\-line interface for orchestrating multiple
  15. Cline AI coding agents.
  16. Cline is an autonomous AI agent who can read, write, and execute code
  17. across your projects.
  18. He operates through a client\-server architecture where \f[B]Cline
  19. Core\f[R] runs as a standalone service, and the CLI acts as a scriptable
  20. interface for managing tasks, instances, and agent interactions.
  21. .PP
  22. The CLI is designed for both interactive use and automation, making it
  23. ideal for CI/CD pipelines, parallel task execution, and terminal\-based
  24. workflows.
  25. Multiple frontends (CLI, VSCode, JetBrains) can attach to the same Cline
  26. Core instance, enabling seamless task handoff between environments.
  27. .SH MODES OF OPERATION
  28. .TP
  29. \f[B]Instant Task Mode\f[R]
  30. The simplest invocation: \f[B]cline \(lqprompt here\(rq\f[R] immediately
  31. spawns an instance, creates a task, and enters chat mode.
  32. This is equivalent to running \f[B]cline instance new && cline task new
  33. && cline task chat\f[R] in sequence.
  34. .TP
  35. \f[B]Subcommand Mode\f[R]
  36. Advanced usage with explicit control: \f[B]cline <command> [subcommand]
  37. [options]\f[R] provides fine\-grained control over instances, tasks,
  38. authentication, and configuration.
  39. .SH AGENT BEHAVIOR
  40. Cline operates in two primary modes:
  41. .TP
  42. \f[B]ACT MODE\f[R]
  43. Cline actively uses tools to accomplish tasks.
  44. He can read files, write code, execute commands, use a headless browser,
  45. and more.
  46. This is the default mode for task execution.
  47. .TP
  48. \f[B]PLAN MODE\f[R]
  49. Cline gathers information and creates a detailed plan before
  50. implementation.
  51. He explores the codebase, asks clarifying questions, and presents a
  52. strategy for user approval before switching to ACT MODE.
  53. .SH INSTANT TASK OPTIONS
  54. When using the instant task syntax \f[B]cline \(lqprompt\(rq\f[R] the
  55. following options are available:
  56. .TP
  57. \f[B]\-o\f[R], \f[B]\-\-oneshot\f[R]
  58. Full autonomous mode.
  59. Cline completes the task and stops following after completion.
  60. Example: cline \-o \(lqwhat\(cqs 6 + 8?\(rq
  61. .TP
  62. \f[B]\-s\f[R], \f[B]\-\-setting\f[R] \f[I]setting\f[R] \f[I]value\f[R]
  63. Override a setting for this task
  64. .TP
  65. \f[B]\-y\f[R], \f[B]\-\-no\-interactive\f[R], \f[B]\-\-yolo\f[R]
  66. Enable fully autonomous mode.
  67. Disables all interactivity:
  68. .RS
  69. .IP \(bu 2
  70. ask_followup_question tool is disabled
  71. .IP \(bu 2
  72. attempt_completion happens automatically
  73. .IP \(bu 2
  74. execute_command runs in non\-blocking mode with timeout
  75. .IP \(bu 2
  76. PLAN MODE automatically switches to ACT MODE
  77. .RE
  78. .TP
  79. \f[B]\-m\f[R], \f[B]\-\-mode\f[R] \f[I]mode\f[R]
  80. Starting mode.
  81. Options: \f[B]act\f[R] (default), \f[B]plan\f[R]
  82. .SH GLOBAL OPTIONS
  83. These options apply to all subcommands:
  84. .TP
  85. \f[B]\-F\f[R], \f[B]\-\-output\-format\f[R] \f[I]format\f[R]
  86. Output format.
  87. Options: \f[B]rich\f[R] (default), \f[B]json\f[R], \f[B]plain\f[R]
  88. .TP
  89. \f[B]\-h\f[R], \f[B]\-\-help\f[R]
  90. Display help information for the command.
  91. .TP
  92. \f[B]\-v\f[R], \f[B]\-\-verbose\f[R]
  93. Enable verbose output for debugging.
  94. .SH COMMANDS
  95. .SS Authentication
  96. \f[B]cline auth\f[R] [\f[I]provider\f[R]] [\f[I]key\f[R]]
  97. .TP
  98. \f[B]cline a\f[R] [\f[I]provider\f[R]] [\f[I]key\f[R]]
  99. Configure authentication for AI model providers.
  100. Launches an interactive wizard if no arguments provided.
  101. If provider is specified without a key, prompts for the key or launches
  102. the appropriate OAuth flow.
  103. .SS Instance Management
  104. Cline Core instances are independent agent processes that can run in the
  105. background.
  106. Multiple instances can run simultaneously, enabling parallel task
  107. execution.
  108. .PP
  109. \f[B]cline instance\f[R]
  110. .TP
  111. \f[B]cline i\f[R]
  112. Display instance management help.
  113. .PP
  114. \f[B]cline instance new\f[R] [\f[B]\-d\f[R]|\f[B]\-\-default\f[R]]
  115. .TP
  116. \f[B]cline i n\f[R] [\f[B]\-d\f[R]|\f[B]\-\-default\f[R]]
  117. Spawn a new Cline Core instance.
  118. Use \f[B]\-\-default\f[R] to set it as the default instance for
  119. subsequent commands.
  120. .PP
  121. \f[B]cline instance list\f[R]
  122. .TP
  123. \f[B]cline i l\f[R]
  124. List all running Cline Core instances with their addresses and status.
  125. .PP
  126. \f[B]cline instance default\f[R] \f[I]address\f[R]
  127. .TP
  128. \f[B]cline i d\f[R] \f[I]address\f[R]
  129. Set the default instance to avoid specifying \f[B]\-\-address\f[R] in
  130. task commands.
  131. .PP
  132. \f[B]cline instance kill\f[R] \f[I]address\f[R]
  133. [\f[B]\-a\f[R]|\f[B]\-\-all\f[R]]
  134. .TP
  135. \f[B]cline i k\f[R] \f[I]address\f[R] [\f[B]\-a\f[R]|\f[B]\-\-all\f[R]]
  136. Terminate a Cline Core instance.
  137. Use \f[B]\-\-all\f[R] to kill all running instances.
  138. .SS Task Management
  139. Tasks represent individual work items that Cline executes.
  140. Tasks maintain conversation history, checkpoints, and settings.
  141. .PP
  142. \f[B]cline task\f[R] [\f[B]\-a\f[R]|\f[B]\-\-address\f[R]
  143. \f[I]ADDR\f[R]]
  144. .TP
  145. \f[B]cline t\f[R] [\f[B]\-a\f[R]|\f[B]\-\-address\f[R] \f[I]ADDR\f[R]]
  146. Display task management help.
  147. The \f[B]\-\-address\f[R] flag specifies which Cline Core instance to
  148. use (e.g., localhost:50052).
  149. .PP
  150. \f[B]cline task new\f[R] \f[I]prompt\f[R] [\f[I]options\f[R]]
  151. .TP
  152. \f[B]cline t n\f[R] \f[I]prompt\f[R] [\f[I]options\f[R]]
  153. Create a new task in the default or specified instance.
  154. Options:
  155. .RS
  156. .TP
  157. \f[B]\-s\f[R], \f[B]\-\-setting\f[R] \f[I]setting\f[R] \f[I]value\f[R]
  158. Set task\-specific settings
  159. .TP
  160. \f[B]\-y\f[R], \f[B]\-\-no\-interactive\f[R], \f[B]\-\-yolo\f[R]
  161. Enable autonomous mode
  162. .TP
  163. \f[B]\-m\f[R], \f[B]\-\-mode\f[R] \f[I]mode\f[R]
  164. Starting mode (act or plan)
  165. .RE
  166. .PP
  167. \f[B]cline task open\f[R] \f[I]task\-id\f[R] [\f[I]options\f[R]]
  168. .TP
  169. \f[B]cline t o\f[R] \f[I]task\-id\f[R] [\f[I]options\f[R]]
  170. Resume a previous task from history.
  171. Accepts the same options as \f[B]task new\f[R].
  172. .PP
  173. \f[B]cline task list\f[R]
  174. .TP
  175. \f[B]cline t l\f[R]
  176. List all tasks in history with their id and snippet
  177. .PP
  178. \f[B]cline task chat\f[R]
  179. .TP
  180. \f[B]cline t c\f[R]
  181. Enter interactive chat mode for the current task.
  182. Allows back\-and\-forth conversation with Cline.
  183. .PP
  184. \f[B]cline task send\f[R] [\f[I]message\f[R]] [\f[I]options\f[R]]
  185. .TP
  186. \f[B]cline t s\f[R] [\f[I]message\f[R]] [\f[I]options\f[R]]
  187. Send a message to Cline.
  188. If no message is provided, reads from stdin.
  189. Options:
  190. .RS
  191. .TP
  192. \f[B]\-a\f[R], \f[B]\-\-approve\f[R]
  193. Approve Cline\(cqs proposed action
  194. .TP
  195. \f[B]\-d\f[R], \f[B]\-\-deny\f[R]
  196. Deny Cline\(cqs proposed action
  197. .TP
  198. \f[B]\-f\f[R], \f[B]\-\-file\f[R] \f[I]FILE\f[R]
  199. Attach a file to the message
  200. .TP
  201. \f[B]\-y\f[R], \f[B]\-\-no\-interactive\f[R], \f[B]\-\-yolo\f[R]
  202. Enable autonomous mode
  203. .TP
  204. \f[B]\-m\f[R], \f[B]\-\-mode\f[R] \f[I]mode\f[R]
  205. Switch mode (act or plan)
  206. .RE
  207. .PP
  208. \f[B]cline task view\f[R] [\f[B]\-f\f[R]|\f[B]\-\-follow\f[R]]
  209. [\f[B]\-c\f[R]|\f[B]\-\-follow\-complete\f[R]]
  210. .TP
  211. \f[B]cline t v\f[R] [\f[B]\-f\f[R]|\f[B]\-\-follow\f[R]] [\f[B]\-c\f[R]|\f[B]\-\-follow\-complete\f[R]]
  212. Display the current conversation.
  213. Use \f[B]\-\-follow\f[R] to stream updates in real\-time, or
  214. \f[B]\-\-follow\-complete\f[R] to follow until task completion.
  215. .PP
  216. \f[B]cline task restore\f[R] \f[I]checkpoint\f[R]
  217. .TP
  218. \f[B]cline t r\f[R] \f[I]checkpoint\f[R]
  219. Restore the task to a previous checkpoint state.
  220. .PP
  221. \f[B]cline task pause\f[R]
  222. .TP
  223. \f[B]cline t p\f[R]
  224. Pause task execution.
  225. .SS Configuration
  226. Configuration can be set globally.
  227. Override these global settings for a task using the
  228. \f[B]\-\-setting\f[R] flag
  229. .PP
  230. \f[B]cline config\f[R]
  231. .PP
  232. \f[B]cline c\f[R]
  233. .PP
  234. \f[B]cline config set\f[R] \f[I]key\f[R] \f[I]value\f[R]
  235. .TP
  236. \f[B]cline c s\f[R] \f[I]key\f[R] \f[I]value\f[R]
  237. Set a configuration variable.
  238. .PP
  239. \f[B]cline config get\f[R] \f[I]key\f[R]
  240. .TP
  241. \f[B]cline c g\f[R] \f[I]key\f[R]
  242. Read a configuration variable.
  243. .PP
  244. \f[B]cline config list\f[R]
  245. .TP
  246. \f[B]cline c l\f[R]
  247. List all configuration variables and their values.
  248. .SH TASK SETTINGS
  249. Task settings are persisted in the \f[I]\(ti/.cline/x/tasks\f[R]
  250. directory.
  251. When resuming a task with \f[B]cline task open\f[R], task settings are
  252. automatically restored.
  253. .PP
  254. Common settings include:
  255. .TP
  256. \f[B]yolo\f[R]
  257. Enable autonomous mode (true/false)
  258. .TP
  259. \f[B]mode\f[R]
  260. Starting mode (act/plan)
  261. .SH NOTES & EXAMPLES
  262. The \f[B]cline task send\f[R] and \f[B]cline task new\f[R] commands
  263. support reading from stdin, enabling powerful pipeline compositions:
  264. .IP
  265. .EX
  266. cat requirements.txt \f[B]|\f[R] cline task send
  267. echo \(dqRefactor this code\(dq \f[B]|\f[R] cline \-y
  268. .EE
  269. .SS Instance Management
  270. Manage multiple Cline instances:
  271. .IP
  272. .EX
  273. \f[I]# Start a new instance and make it default\f[R]
  274. cline instance new \-\-default
  275. \f[I]# List all running instances\f[R]
  276. cline instance list
  277. \f[I]# Kill a specific instance\f[R]
  278. cline instance kill localhost:50052
  279. \f[I]# Kill all CLI instances\f[R]
  280. cline instance kill \-\-all\-cli
  281. .EE
  282. .SS Task History
  283. Work with task history:
  284. .IP
  285. .EX
  286. \f[I]# List previous tasks\f[R]
  287. cline task list
  288. \f[I]# Resume a previous task\f[R]
  289. cline task open 1760501486669
  290. \f[I]# View conversation history\f[R]
  291. cline task view
  292. \f[I]# Start interactive chat with this task\f[R]
  293. cline task chat
  294. .EE
  295. .SH ARCHITECTURE
  296. Cline operates on a three\-layer architecture:
  297. .TP
  298. \f[B]Presentation Layer\f[R]
  299. User interfaces (CLI, VSCode, JetBrains) that connect to Cline Core via
  300. gRPC
  301. .TP
  302. \f[B]Cline Core\f[R]
  303. The autonomous agent service handling task management, AI model
  304. integration, state management, tool orchestration, and real\-time
  305. streaming updates
  306. .TP
  307. \f[B]Host Provider Layer\f[R]
  308. Environment\-specific integrations (VSCode APIs, JetBrains APIs, shell
  309. APIs) that Cline Core uses to interact with the host system
  310. .SH BUGS
  311. Report bugs at: \c
  312. .UR https://github.com/cline/cline/issues
  313. .UE \c
  314. .PP
  315. For real\-time help, join the Discord community at: \c
  316. .UR https://discord.gg/cline
  317. .UE \c
  318. .SH SEE ALSO
  319. Full documentation: \c
  320. .UR https://docs.cline.bot
  321. .UE \c
  322. .SH AUTHORS
  323. Cline is developed by the Cline Bot Inc.\ and the open source community.
  324. .SH COPYRIGHT
  325. Copyright © 2025 Cline Bot Inc.\ Licensed under the Apache License 2.0.