@complyance/cops-cli
v0.1.5
Published
Complyance CLI tool to create Linear tasks and documentation files from Markdown.
Readme
cops-cli
Complyance CLI tool to automate Linear tasks, GitHub operations, and documentation workflows.
Features
- Create Linear tasks and subtasks from Markdown folders
- Scaffold documentation folders for task planning
- Apply GitHub branch diffs to your working directory
- Conversational AI-powered doc chat for HLD and documentation (Gemini integration)
- Modular: add more providers and automations easily
Installation
npm install -g cops-cliConfiguration
Set your Linear and Gemini API keys (only needed for Linear and doc chat commands):
cops-cli config- You will be prompted for both keys. Press Enter to skip either (keeps existing or leaves blank).
- Keys are saved in
~/.cops-cli/config.json.
Usage
Create Linear Tasks from Markdown
cops-cli create- Select your Markdown folder (with parent.md and subtasks)
- Choose team, project, labels, assignee, and priority
- Issues and subtasks are created in Linear, and .md files are updated with issue IDs
Scaffold Documentation Folders
cops-cli doc- Prompts for parent folder and subtask names
- Creates skeleton Markdown files for you to fill in
Apply GitHub Branch Diff
cops-cli github:apply-diff <branch>- Applies the diff from the specified branch to your current working directory (like a smart patch)
Conversational AI Doc Chat (Gemini-powered)
cops-cli doc:chat- Select a feature folder (e.g., a folder containing HLD.md and task subfolders)
- Select a doc file to edit (e.g., HLD.md)
- Select any number of context files (Markdown, code, images)
- Start an interactive chat with Gemini to generate, update, or expand documentation
- Supported context file types:
.md,.ts,.js,.json,.py,.java,.go,.sh,.yaml,.yml,.txt,.png,.jpg,.jpeg,.gif - Use chat commands:
/help— Show available commands/save— Write the last AI response to the doc file (append/overwrite)/exit— End the session and save conversation history
- Conversation history is saved as
.convo.jsonin the feature folder
Example Workflow
# Set your API keys (first time only)
cops-cli config
# Start an AI-powered doc chat session
cops-cli doc:chat
# Select your feature folder and doc file (e.g., HLD.md)
# Select context files (e.g., requirements.md, diagram.png, api.ts)
# Chat with Gemini to draft or update documentation
# Use /save to write AI output to your doc file
# Use /exit to end and save the conversationExtending
- Add more providers (Jira, Asana, etc.) in
src/providers/ - Add more commands for GitHub or other tools as needed
© Complyance. MIT License.
