@citeme/cli

CiteMe CLI - Audit your GEO score and apply optimizations directly in your codebase.

Installation

# Global installation (recommended)
npm install -g @citeme/cli

# Or with npx (no installation required)
npx @citeme/cli

# Local development (from the monorepo root)
cd packages/cli
npm install
npm run build
npm link  # Makes 'citeme' available globally

Quick Start

# Login to your CiteMe account
citeme login

# Run a GEO audit on your project
citeme audit

# Generate content suggestions based on the audit
citeme suggestions generate

# List all suggestions
citeme suggestions list

# Apply technical suggestions
citeme apply

Commands

citeme login

Authenticate with your CiteMe account. Your API key is stored securely in ~/.config/citeme/.

citeme login

citeme logout

Log out and remove stored credentials.

citeme logout

citeme whoami

Display current user information and validate your session.

citeme whoami

citeme audit

Analyze your project for GEO optimization opportunities.

# Basic audit
citeme audit

# With project URL for enhanced analysis
citeme audit --url https://example.com

# Verbose output with detailed issues
citeme audit --verbose

# JSON output for CI/CD integration
citeme audit --json

Options:

• -u, --url <url> - Project URL for enhanced analysis
• -v, --verbose - Show detailed output
• --json - Output results as JSON

citeme suggestions generate

Generate AI-powered content suggestions based on your latest audit.

# Generate suggestions from latest audit
citeme suggestions generate

# Use a specific audit
citeme suggestions generate --audit-id <id>

# Specify suggestion types
citeme suggestions generate --types LINKEDIN_POST,BLOG_ARTICLE

# Limit number of suggestions per type
citeme suggestions generate --count 5

Options:

• -a, --audit-id <id> - Use a specific audit
• -t, --types <types> - Comma-separated list: LINKEDIN_POST, BLOG_ARTICLE, WEBSITE_OPTIMIZATION, TWEET
• -c, --count <number> - Number of suggestions per type (default: 3)

citeme suggestions list

List all suggestions for your organization.

# List all suggestions
citeme suggestions list

# Filter by status
citeme suggestions list --status PENDING

# Filter by type
citeme suggestions list --type LINKEDIN_POST

# Limit results
citeme suggestions list --limit 10

# JSON output
citeme suggestions list --json

Options:

• -s, --status <status> - Filter: PENDING, APPROVED, PUBLISHED, REJECTED
• -t, --type <type> - Filter: LINKEDIN_POST, BLOG_ARTICLE, etc.
• -l, --limit <number> - Maximum results (default: 20)
• --json - Output as JSON

citeme suggestions view <id>

View the full content of a specific suggestion.

citeme suggestions view abc12345

citeme apply

Apply approved technical suggestions to your code. Only technical suggestions (meta tags, ARIA attributes, JSON-LD, alt text) are applied - editorial suggestions are ignored.

# Interactive mode (default)
citeme apply

# Apply patches from a specific audit
citeme apply --audit-id <id>

# Apply all patches without confirmation
citeme apply --all

# Preview changes without applying them
citeme apply --dry-run

Options:

• -a, --audit-id <id> - Apply patches from a specific audit
• --all - Apply all patches without confirmation
• --dry-run - Preview changes without applying them

citeme status

Show CLI status and configuration.

citeme status

citeme config

Show configuration file path.

citeme config

Supported File Types

The CLI analyzes the following file types:

Content Files:

• .md - Markdown
• .mdx - MDX (Markdown with JSX)

Structure Files:

• .tsx - TypeScript React
• .jsx - JavaScript React
• .ts - TypeScript
• .js - JavaScript

Technical Checks

The CLI performs the following technical checks:

• SEO

  • Page title presence
  • Meta description
  • H1 heading (single)

• Structured Data

  • JSON-LD schema markup

• Accessibility

  • Image alt text
  • ARIA labels on interactive elements

• Content

  • Minimum word count
  • MDX frontmatter

Safety Features

• Backup Creation: Before any modification, the CLI creates a .bak backup file
• Interactive Confirmation: Each change requires confirmation (unless --all is used)
• Rollback Support: If you quit during apply, all changes are rolled back
• Diff Preview: View exact changes before applying

CI/CD Integration

Use the --json flag for machine-readable output:

citeme audit --json | jq '.score'

Example GitHub Action:

- name: Run GEO Audit
  run: |
    npm install -g @citeme/cli
    citeme login # Uses CITEME_API_KEY env var
    SCORE=$(citeme audit --json | jq '.score')
    if [ "$SCORE" -lt 60 ]; then
      echo "GEO score is below threshold: $SCORE"
      exit 1
    fi

Configuration

The CLI stores configuration in ~/.config/citeme/config.json:

{
  "apiKey": "your-api-key",
  "apiUrl": "https://citeme.io",
  "email": "[email protected]"
}

License

MIT