Skip to main content

CLI Overview

The ArchiCore CLI provides a powerful command-line interface for analyzing and exploring your codebase.

Installation​

npm install -g archicore

Quick Start​

cd /path/to/your/project
archicore

That's it! ArchiCore automatically:

  1. Initializes the project if needed
  2. Asks to index your codebase
  3. Starts interactive mode

Basic Usage​

# Start interactive mode (recommended)
archicore

# Run a specific command
archicore <command> [options]

Interactive Mode​

When you run archicore, you enter interactive mode:

$ archicore

  ℹ ArchiCore not initialized in this directory.
  ⚡ Initializing automatically...

  ArchiCore initialized locally

  ⚠ Project not indexed yet.
  Index project now? [Y/n] y

  ✓ Project indexed and uploaded

  ╔═══════════════════════════════════════╗
  ║  ArchiCore - AI Software Architect    ║
  ╚═══════════════════════════════════════╝

  Type / to see commands, or ask a question about your code.

>

In interactive mode, you can:

  • Type natural language questions about your code
  • Use / commands for specific actions
  • Press Tab to autocomplete commands
  • Navigate with arrow keys through history

Command Categories​

CategoryDescription
Analysis/analyze, /metrics, /security, /dead-code
Search/search, /find
Project/index, /status, /export
Rules/rules, /validate
AINatural language questions

Quick Reference​

# Index current project
archicore index

# Search for code
archicore search "user authentication"

# Analyze impact of changes
archicore analyze src/auth/

# Check code metrics
archicore metrics

# Find security issues
archicore security

# Export report
archicore export --format html

Configuration​

ArchiCore stores configuration in .archicore/ directory:

.archicore/
├── config.json      # Project configuration
├── rules.json       # Architecture rules
└── cache/           # Index cache

Next Steps​