How to Use CoAuthor from the CLI

Use this guide to install the CoAuthor CLI, sign in, create a project, run an editorial workflow, and export a finished draft.

Written by ClickMinded

Use this guide to install the CoAuthor CLI, sign in, create a project, run an editorial workflow, and export a finished draft.

If you are using an AI agent such as Claude Code, Codex, or Cursor, you can also send the agent a link to this article. The agent can follow these steps to handle the CLI installation, setup, and workflow commands directly in your environment.

What the CoAuthor CLI does

The CoAuthor CLI lets you use CoAuthor from the terminal. You can run it yourself, or you can let an agent such as Claude Code, Codex, or Cursor use it as part of a content workflow.

You can use the CLI to:

  • sign in to your CoAuthor account
  • create and inspect projects
  • run editorial workflows
  • generate outlines, research plans, drafts, images, threads, and other outputs
  • export drafts in formats such as Markdown, HTML, text, or JSON
  • install CoAuthor skills for supported agent environments

The CLI is useful when you want CoAuthor work to fit into an agent workflow, a repository workflow, or a repeatable terminal process.

Before you start

You’ll need:

  • a CoAuthor account with access to CoAuthor
  • Node.js installed on your computer
  • access to your terminal
  • permission to install npm packages globally

Optional:

  • Claude Code, Codex, Cursor, or another supported agent environment if you want to use CoAuthor through an agent

Step 1: Install or update the CLI

Run:

npm install -g @clickminded/coauthor-cli@latest

After installation, check that the command is available:

coauthor --help

You should see a list of available CoAuthor commands, including auth, project, workflow, draft, models, and skills.

Step 2: Sign in

Run:

coauthor auth login

Follow the sign-in instructions shown in your terminal.

After signing in, you can check your session:

coauthor auth status

Once your session is active, the CLI can connect your terminal commands to your CoAuthor account.

Step 3: Create a project

Run:

coauthor project create

A CoAuthor project is the workspace for one piece of content or one editorial job. It can store the brief, workflow state, outline, research plan, draft, and related outputs.

After creating a project, you can list your projects:

coauthor project list

You can also inspect a project:

coauthor project show

Step 4: Run an editorial workflow

Run:

coauthor workflow run --target draft --wait

The --target draft option tells CoAuthor to run the workflow until a draft is ready.

The --wait option keeps the command open while CoAuthor works. This is useful when you want the terminal, script, or agent to wait for the finished result before moving to the next step.

If you want CoAuthor to require a brief review before continuing, run:

coauthor workflow run --target draft --require-brief-review --wait

Step 5: Check workflow status

If you start a workflow without waiting, or if you want to check progress later, run:

coauthor workflow status

You can also inspect the current workflow state:

coauthor workflow show

Use these commands when a workflow is still running, paused, or waiting for review.

Step 6: Get the draft

After the draft is ready, run:

coauthor draft get --format markdown

Markdown is usually the best format when you want to review the draft, add it to a website repository, or hand it to another writing or publishing tool.

Other supported draft formats include:

  • json
  • markdown
  • html
  • text

For example:

coauthor draft get --format html

Use HTML when another system expects formatted HTML. Use JSON when an agent or script needs structured output.

Step 7: Install CoAuthor skills for your agent

If you use an agent environment, install the matching CoAuthor skill.

For Codex:

coauthor skills install codex

For Claude Code:

coauthor skills install claude

For Cursor:

coauthor skills install cursor

You can see available skills with:

coauthor skills list

CoAuthor skills help your agent understand how to use the CoAuthor workflow correctly. They are useful when you want an agent to create projects, run workflows, retrieve drafts, and keep the work organized.

What happens after you run a workflow

After you run a CoAuthor workflow:

  • CoAuthor uses the project as the workspace for the content job
  • the workflow advances through the required editorial steps
  • planning, research, writing, and output generation run through CoAuthor
  • the CLI shows status updates or waits for completion, depending on the command you used
  • finished drafts can be retrieved through coauthor draft get

The CLI does not publish your content automatically. You still review the draft and decide where it should go next.

Useful CLI commands

Use these commands as a quick reference:

coauthor auth login
coauthor auth status
coauthor project create
coauthor project list
coauthor project show
coauthor workflow run --target draft --wait
coauthor workflow status
coauthor workflow show
coauthor draft get --format markdown
coauthor skills list
coauthor skills install codex

Troubleshooting

The coauthor command is not found

Install or update the CLI:

npm install -g @clickminded/coauthor-cli@latest

Then run:

coauthor --help

If the command is still not found, your npm global install path may not be available in your terminal.

The CLI says you are not signed in

Run:

coauthor auth login

Then check your session:

coauthor auth status

The workflow is still running

Check the workflow status:

coauthor workflow status

If you want the terminal to wait for the workflow next time, run the workflow with --wait.

The workflow is waiting for review

This can happen when a workflow requires approval before moving forward.

Inspect the workflow:

coauthor workflow show

Then approve or advance the workflow from the CLI when you are ready:

coauthor workflow approve
coauthor workflow advance

The draft is missing or not ready

Check whether the workflow has reached the draft stage:

coauthor workflow status

If draft generation is still running, wait for it to finish. If the workflow paused earlier, resume it:

coauthor workflow resume --target draft --wait

An agent skill install fails

List the supported skills:

coauthor skills list

Then install the matching skill for your environment:

coauthor skills install codex
coauthor skills install claude
coauthor skills install cursor

CoAuthor asks for an AI provider key

This can happen when included credits are exhausted and CoAuthor needs your own provider key to continue.

Open CoAuthor AI settings:

https://tools.clickminded.com/coauthor/settings/ai

Add the required provider key, then resume the workflow:

coauthor workflow resume --target draft --wait

For model settings, see the related article:

https://www.clickminded.com/kb/coauthor-ai-model-settings/

Frequently asked questions

Do I need to be technical to use the CoAuthor CLI?

You need to be comfortable copying commands into a terminal, but you do not need to be a developer. Most CoAuthor CLI work follows a short sequence: sign in, create a project, run a workflow, and retrieve the draft.

Can I use the CLI without Claude Code, Codex, or Cursor?

Yes. You can run the CoAuthor CLI directly from your terminal. Agent skills are optional and are only needed when you want an agent environment to use CoAuthor more reliably.

Does the CLI publish content automatically?

No. The CLI can generate and export content, but it does not publish your draft automatically. Review the output before adding it to your website, CMS, newsletter tool, or social workflow.

Can I use the CLI in scripts or recurring workflows?

Yes. The CLI works well in repeatable workflows because commands can be run from the terminal, scripts, or agent instructions. Use --wait when the next step should not start until CoAuthor finishes the current workflow.

Which draft format should I use?

Use Markdown for blog posts, docs, GitHub review, and most website workflows. Use HTML when another system expects HTML. Use JSON when a script or agent needs structured output.

Need help?

If you run into issues, contact support: