mirror of
https://github.com/cline/cline.git
synced 2026-09-19 02:05:44 +08:00
332 lines
9.9 KiB
Groff
332 lines
9.9 KiB
Groff
.\" Automatically generated by Pandoc 3.8.2
|
|
.\"
|
|
.TH "CLINE" "1" "January 2025" "Cline CLI 1.0" "User Commands"
|
|
.SH NAME
|
|
cline \- orchestrate and interact with Cline AI coding agents
|
|
.SH SYNOPSIS
|
|
\f[B]cline\f[R] [\f[I]prompt\f[R]] [\f[I]options\f[R]]
|
|
.PP
|
|
\f[B]cline\f[R] \f[I]command\f[R] [\f[I]subcommand\f[R]]
|
|
[\f[I]options\f[R]] [\f[I]arguments\f[R]]
|
|
.SH DESCRIPTION
|
|
Try: cat README.md | cline \(lqSummarize this for me:\(rq
|
|
.PP
|
|
\f[B]cline\f[R] is a command\-line interface for orchestrating multiple
|
|
Cline AI coding agents.
|
|
Cline is an autonomous AI agent who can read, write, and execute code
|
|
across your projects.
|
|
He operates through a client\-server architecture where \f[B]Cline
|
|
Core\f[R] runs as a standalone service, and the CLI acts as a scriptable
|
|
interface for managing tasks, instances, and agent interactions.
|
|
.PP
|
|
The CLI is designed for both interactive use and automation, making it
|
|
ideal for CI/CD pipelines, parallel task execution, and terminal\-based
|
|
workflows.
|
|
Multiple frontends (CLI, VSCode, JetBrains) can attach to the same Cline
|
|
Core instance, enabling seamless task handoff between environments.
|
|
.SH MODES OF OPERATION
|
|
.TP
|
|
\f[B]Instant Task Mode\f[R]
|
|
The simplest invocation: \f[B]cline \(lqprompt here\(rq\f[R] immediately
|
|
spawns an instance, creates a task, and enters chat mode.
|
|
This is equivalent to running \f[B]cline instance new && cline task new
|
|
&& cline task chat\f[R] in sequence.
|
|
.TP
|
|
\f[B]Subcommand Mode\f[R]
|
|
Advanced usage with explicit control: \f[B]cline <command> [subcommand]
|
|
[options]\f[R] provides fine\-grained control over instances, tasks,
|
|
authentication, and configuration.
|
|
.SH AGENT BEHAVIOR
|
|
Cline operates in two primary modes:
|
|
.TP
|
|
\f[B]ACT MODE\f[R]
|
|
Cline actively uses tools to accomplish tasks.
|
|
He can read files, write code, execute commands, use a headless browser,
|
|
and more.
|
|
This is the default mode for task execution.
|
|
.TP
|
|
\f[B]PLAN MODE\f[R]
|
|
Cline gathers information and creates a detailed plan before
|
|
implementation.
|
|
He explores the codebase, asks clarifying questions, and presents a
|
|
strategy for user approval before switching to ACT MODE.
|
|
.SH INSTANT TASK OPTIONS
|
|
When using the instant task syntax \f[B]cline \(lqprompt\(rq\f[R] the
|
|
following options are available:
|
|
.TP
|
|
\f[B]\-o\f[R], \f[B]\-\-oneshot\f[R]
|
|
Full autonomous mode.
|
|
Cline completes the task and stops following after completion.
|
|
Example: cline \-o \(lqwhat\(cqs 6 + 8?\(rq
|
|
.TP
|
|
\f[B]\-s\f[R], \f[B]\-\-setting\f[R] \f[I]setting\f[R] \f[I]value\f[R]
|
|
Override a setting for this task
|
|
.TP
|
|
\f[B]\-y\f[R], \f[B]\-\-no\-interactive\f[R], \f[B]\-\-yolo\f[R]
|
|
Enable fully autonomous mode.
|
|
Disables all interactivity:
|
|
.RS
|
|
.IP \(bu 2
|
|
ask_followup_question tool is disabled
|
|
.IP \(bu 2
|
|
attempt_completion happens automatically
|
|
.IP \(bu 2
|
|
execute_command runs in non\-blocking mode with timeout
|
|
.IP \(bu 2
|
|
PLAN MODE automatically switches to ACT MODE
|
|
.RE
|
|
.TP
|
|
\f[B]\-m\f[R], \f[B]\-\-mode\f[R] \f[I]mode\f[R]
|
|
Starting mode.
|
|
Options: \f[B]act\f[R] (default), \f[B]plan\f[R]
|
|
.SH GLOBAL OPTIONS
|
|
These options apply to all subcommands:
|
|
.TP
|
|
\f[B]\-F\f[R], \f[B]\-\-output\-format\f[R] \f[I]format\f[R]
|
|
Output format.
|
|
Options: \f[B]rich\f[R] (default), \f[B]json\f[R], \f[B]plain\f[R]
|
|
.TP
|
|
\f[B]\-h\f[R], \f[B]\-\-help\f[R]
|
|
Display help information for the command.
|
|
.TP
|
|
\f[B]\-v\f[R], \f[B]\-\-verbose\f[R]
|
|
Enable verbose output for debugging.
|
|
.SH COMMANDS
|
|
.SS Authentication
|
|
\f[B]cline auth\f[R] [\f[I]provider\f[R]] [\f[I]key\f[R]]
|
|
.TP
|
|
\f[B]cline a\f[R] [\f[I]provider\f[R]] [\f[I]key\f[R]]
|
|
Configure authentication for AI model providers.
|
|
Launches an interactive wizard if no arguments provided.
|
|
If provider is specified without a key, prompts for the key or launches
|
|
the appropriate OAuth flow.
|
|
.SS Instance Management
|
|
Cline Core instances are independent agent processes that can run in the
|
|
background.
|
|
Multiple instances can run simultaneously, enabling parallel task
|
|
execution.
|
|
.PP
|
|
\f[B]cline instance\f[R]
|
|
.TP
|
|
\f[B]cline i\f[R]
|
|
Display instance management help.
|
|
.PP
|
|
\f[B]cline instance new\f[R] [\f[B]\-d\f[R]|\f[B]\-\-default\f[R]]
|
|
.TP
|
|
\f[B]cline i n\f[R] [\f[B]\-d\f[R]|\f[B]\-\-default\f[R]]
|
|
Spawn a new Cline Core instance.
|
|
Use \f[B]\-\-default\f[R] to set it as the default instance for
|
|
subsequent commands.
|
|
.PP
|
|
\f[B]cline instance list\f[R]
|
|
.TP
|
|
\f[B]cline i l\f[R]
|
|
List all running Cline Core instances with their addresses and status.
|
|
.PP
|
|
\f[B]cline instance default\f[R] \f[I]address\f[R]
|
|
.TP
|
|
\f[B]cline i d\f[R] \f[I]address\f[R]
|
|
Set the default instance to avoid specifying \f[B]\-\-address\f[R] in
|
|
task commands.
|
|
.PP
|
|
\f[B]cline instance kill\f[R] \f[I]address\f[R]
|
|
[\f[B]\-a\f[R]|\f[B]\-\-all\f[R]]
|
|
.TP
|
|
\f[B]cline i k\f[R] \f[I]address\f[R] [\f[B]\-a\f[R]|\f[B]\-\-all\f[R]]
|
|
Terminate a Cline Core instance.
|
|
Use \f[B]\-\-all\f[R] to kill all running instances.
|
|
.SS Task Management
|
|
Tasks represent individual work items that Cline executes.
|
|
Tasks maintain conversation history, checkpoints, and settings.
|
|
.PP
|
|
\f[B]cline task\f[R] [\f[B]\-a\f[R]|\f[B]\-\-address\f[R]
|
|
\f[I]ADDR\f[R]]
|
|
.TP
|
|
\f[B]cline t\f[R] [\f[B]\-a\f[R]|\f[B]\-\-address\f[R] \f[I]ADDR\f[R]]
|
|
Display task management help.
|
|
The \f[B]\-\-address\f[R] flag specifies which Cline Core instance to
|
|
use (e.g., localhost:50052).
|
|
.PP
|
|
\f[B]cline task new\f[R] \f[I]prompt\f[R] [\f[I]options\f[R]]
|
|
.TP
|
|
\f[B]cline t n\f[R] \f[I]prompt\f[R] [\f[I]options\f[R]]
|
|
Create a new task in the default or specified instance.
|
|
Options:
|
|
.RS
|
|
.TP
|
|
\f[B]\-s\f[R], \f[B]\-\-setting\f[R] \f[I]setting\f[R] \f[I]value\f[R]
|
|
Set task\-specific settings
|
|
.TP
|
|
\f[B]\-y\f[R], \f[B]\-\-no\-interactive\f[R], \f[B]\-\-yolo\f[R]
|
|
Enable autonomous mode
|
|
.TP
|
|
\f[B]\-m\f[R], \f[B]\-\-mode\f[R] \f[I]mode\f[R]
|
|
Starting mode (act or plan)
|
|
.RE
|
|
.PP
|
|
\f[B]cline task open\f[R] \f[I]task\-id\f[R] [\f[I]options\f[R]]
|
|
.TP
|
|
\f[B]cline t o\f[R] \f[I]task\-id\f[R] [\f[I]options\f[R]]
|
|
Resume a previous task from history.
|
|
Accepts the same options as \f[B]task new\f[R].
|
|
.PP
|
|
\f[B]cline task list\f[R]
|
|
.TP
|
|
\f[B]cline t l\f[R]
|
|
List all tasks in history with their id and snippet
|
|
.PP
|
|
\f[B]cline task chat\f[R]
|
|
.TP
|
|
\f[B]cline t c\f[R]
|
|
Enter interactive chat mode for the current task.
|
|
Allows back\-and\-forth conversation with Cline.
|
|
.PP
|
|
\f[B]cline task send\f[R] [\f[I]message\f[R]] [\f[I]options\f[R]]
|
|
.TP
|
|
\f[B]cline t s\f[R] [\f[I]message\f[R]] [\f[I]options\f[R]]
|
|
Send a message to Cline.
|
|
If no message is provided, reads from stdin.
|
|
Options:
|
|
.RS
|
|
.TP
|
|
\f[B]\-a\f[R], \f[B]\-\-approve\f[R]
|
|
Approve Cline\(cqs proposed action
|
|
.TP
|
|
\f[B]\-d\f[R], \f[B]\-\-deny\f[R]
|
|
Deny Cline\(cqs proposed action
|
|
.TP
|
|
\f[B]\-f\f[R], \f[B]\-\-file\f[R] \f[I]FILE\f[R]
|
|
Attach a file to the message
|
|
.TP
|
|
\f[B]\-y\f[R], \f[B]\-\-no\-interactive\f[R], \f[B]\-\-yolo\f[R]
|
|
Enable autonomous mode
|
|
.TP
|
|
\f[B]\-m\f[R], \f[B]\-\-mode\f[R] \f[I]mode\f[R]
|
|
Switch mode (act or plan)
|
|
.RE
|
|
.PP
|
|
\f[B]cline task view\f[R] [\f[B]\-f\f[R]|\f[B]\-\-follow\f[R]]
|
|
[\f[B]\-c\f[R]|\f[B]\-\-follow\-complete\f[R]]
|
|
.TP
|
|
\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]]
|
|
Display the current conversation.
|
|
Use \f[B]\-\-follow\f[R] to stream updates in real\-time, or
|
|
\f[B]\-\-follow\-complete\f[R] to follow until task completion.
|
|
.PP
|
|
\f[B]cline task restore\f[R] \f[I]checkpoint\f[R]
|
|
.TP
|
|
\f[B]cline t r\f[R] \f[I]checkpoint\f[R]
|
|
Restore the task to a previous checkpoint state.
|
|
.PP
|
|
\f[B]cline task pause\f[R]
|
|
.TP
|
|
\f[B]cline t p\f[R]
|
|
Pause task execution.
|
|
.SS Configuration
|
|
Configuration can be set globally.
|
|
Override these global settings for a task using the
|
|
\f[B]\-\-setting\f[R] flag
|
|
.PP
|
|
\f[B]cline config\f[R]
|
|
.PP
|
|
\f[B]cline c\f[R]
|
|
.PP
|
|
\f[B]cline config set\f[R] \f[I]key\f[R] \f[I]value\f[R]
|
|
.TP
|
|
\f[B]cline c s\f[R] \f[I]key\f[R] \f[I]value\f[R]
|
|
Set a configuration variable.
|
|
.PP
|
|
\f[B]cline config get\f[R] \f[I]key\f[R]
|
|
.TP
|
|
\f[B]cline c g\f[R] \f[I]key\f[R]
|
|
Read a configuration variable.
|
|
.PP
|
|
\f[B]cline config list\f[R]
|
|
.TP
|
|
\f[B]cline c l\f[R]
|
|
List all configuration variables and their values.
|
|
.SH TASK SETTINGS
|
|
Task settings are persisted in the \f[I]\(ti/.cline/x/tasks\f[R]
|
|
directory.
|
|
When resuming a task with \f[B]cline task open\f[R], task settings are
|
|
automatically restored.
|
|
.PP
|
|
Common settings include:
|
|
.TP
|
|
\f[B]yolo\f[R]
|
|
Enable autonomous mode (true/false)
|
|
.TP
|
|
\f[B]mode\f[R]
|
|
Starting mode (act/plan)
|
|
.SH NOTES & EXAMPLES
|
|
The \f[B]cline task send\f[R] and \f[B]cline task new\f[R] commands
|
|
support reading from stdin, enabling powerful pipeline compositions:
|
|
.IP
|
|
.EX
|
|
cat requirements.txt \f[B]|\f[R] cline task send
|
|
echo \(dqRefactor this code\(dq \f[B]|\f[R] cline \-y
|
|
.EE
|
|
.SS Instance Management
|
|
Manage multiple Cline instances:
|
|
.IP
|
|
.EX
|
|
\f[I]# Start a new instance and make it default\f[R]
|
|
cline instance new \-\-default
|
|
|
|
\f[I]# List all running instances\f[R]
|
|
cline instance list
|
|
|
|
\f[I]# Kill a specific instance\f[R]
|
|
cline instance kill localhost:50052
|
|
|
|
\f[I]# Kill all CLI instances\f[R]
|
|
cline instance kill \-\-all\-cli
|
|
.EE
|
|
.SS Task History
|
|
Work with task history:
|
|
.IP
|
|
.EX
|
|
\f[I]# List previous tasks\f[R]
|
|
cline task list
|
|
|
|
\f[I]# Resume a previous task\f[R]
|
|
cline task open 1760501486669
|
|
|
|
\f[I]# View conversation history\f[R]
|
|
cline task view
|
|
|
|
\f[I]# Start interactive chat with this task\f[R]
|
|
cline task chat
|
|
.EE
|
|
.SH ARCHITECTURE
|
|
Cline operates on a three\-layer architecture:
|
|
.TP
|
|
\f[B]Presentation Layer\f[R]
|
|
User interfaces (CLI, VSCode, JetBrains) that connect to Cline Core via
|
|
gRPC
|
|
.TP
|
|
\f[B]Cline Core\f[R]
|
|
The autonomous agent service handling task management, AI model
|
|
integration, state management, tool orchestration, and real\-time
|
|
streaming updates
|
|
.TP
|
|
\f[B]Host Provider Layer\f[R]
|
|
Environment\-specific integrations (VSCode APIs, JetBrains APIs, shell
|
|
APIs) that Cline Core uses to interact with the host system
|
|
.SH BUGS
|
|
Report bugs at: \c
|
|
.UR https://github.com/cline/cline/issues
|
|
.UE \c
|
|
.PP
|
|
For real\-time help, join the Discord community at: \c
|
|
.UR https://discord.gg/cline
|
|
.UE \c
|
|
.SH SEE ALSO
|
|
Full documentation: \c
|
|
.UR https://docs.cline.bot
|
|
.UE \c
|
|
.SH AUTHORS
|
|
Cline is developed by the Cline Bot Inc.\ and the open source community.
|
|
.SH COPYRIGHT
|
|
Copyright © 2025 Cline Bot Inc.\ Licensed under the Apache License 2.0.
|