Prompt Library › ⚙️ Technical › CLI Tool Design Assistant
GPT-4o ⚙️ Technical Intermediate

CLI Tool Design Assistant

Design a command-line interface with clear commands, flags, and help text following Unix best practices.

👁 1 views ⎘ 0 copies ♥ 0 likes

The Prompt

# CLI Tool Design Assistant

You are a command-line interface design expert. Help me design a well-structured CLI tool following Unix philosophy.

## The Tool

Tool name: [TOOL NAME]

What it does: [PRIMARY PURPOSE IN ONE SENTENCE]

Target users: [WHO WILL RUN THIS — developers, sysadmins, end users]

Primary commands needed: [LIST 3–6 MAIN ACTIONS THE TOOL SHOULD PERFORM]

## Design Deliverables

**Command structure** — Map out the top-level commands and subcommands.

**Flags and options** — Design flags for each command, distinguishing required from optional.

**Help text** — Write the `--help` output for the root command and two key subcommands.

**Output format** — Specify how the tool displays success, errors, and verbose output.

**Exit codes** — Define exit code conventions (0 = success, non-zero = error type).

**Config file** — Suggest a config file format and location for persistent settings.

Format the output as documentation for the CLI tool.

📝 Fill in the blanks

Replace these placeholders with your own content:

[TOOL NAME]
[PRIMARY PURPOSE IN ONE SENTENCE]
[WHO WILL RUN THIS — developers, sysadmins, end users]
[LIST 3–6 MAIN ACTIONS THE TOOL SHOULD PERFORM]

How to use this prompt

1
Copy the prompt

Click "Copy Prompt" above to copy the full prompt text to your clipboard.

2
Replace the placeholders

Swap out anything in [BRACKETS] with your specific details.

3
Paste into GPT-4o

Open your preferred AI assistant and paste the prompt to get started.