Docs

Documentation for shipping prompts with confidence

PromptScore is growing into a real product surface, not just a repository. This docs section is the canonical place for onboarding, reference, workflow guides, and FAQ.

What ships in the first docs release

This `/docs` section is intentionally focused: it explains the current public product clearly, documents the real CLI and browser analyzer behavior, and gives users a trustworthy place to start.

Explore the docs

Start here

Overview

Understand what PromptScore is, what ships today, and where to start.

Start here

Getting Started

Install the CLI, run your first analysis, and use the core library.

Workflows

CLI Guide

Analyze files, directories, globs, inline prompts, and stdin with CI-friendly exit codes.

Workflows

Config

Set project-wide defaults, rule subsets, and failure thresholds.

Workflows

Browser Analyzer

Use the in-browser analyzer and the browser-safe core entry.

Reference

Rules Reference

Learn what the deterministic rules check and how they score prompts.

Reference

Profiles

See how `_base`, `claude`, and `gpt` tune severity, weight, and guidance.

Reference

FAQ

Common questions about scope, privacy, roadmap, and customization.

What these docs should become

Fast onboarding

Short paths for new users: install, analyze a prompt, understand the score, and start improving prompts immediately.

Accurate reference

Every command, profile, and rule should reflect the shipped product, with examples that are tested and current.

Release clarity

As PromptScore evolves, docs should explain what changed, what is stable, and what is still roadmap work.

Recommended reading order

  1. Start with Getting Started to install PromptScore and run your first analysis.
  2. Read the CLI Guide if you want automation, CI integration, or command details.
  3. Read Browser Analyzer if you want to embed PromptScore in a client-side flow.
  4. Use Rules and Profiles as your ongoing reference while refining prompt quality.