using-shannon-cli

krzemienski's avatarfrom krzemienski

Use when starting work with Shannon CLI or need to understand available commands - introduces shannon analyze, wave, do, exec commands, explains when to use each, guides installation and basic workflows

⭐1stars🔀0forks📁View on GitHub🕐Updated Nov 17, 2025
[Developer Tools]

When & Why to Use This Skill

The Shannon CLI skill provides developers with an intelligent command-line interface to interact with the Shannon Framework. It streamlines the entire software development lifecycle—from initial requirement analysis and multi-agent orchestration to autonomous code execution and git automation—while incorporating advanced features like cost optimization, caching, and real-time monitoring.

Use Cases

  • Requirement Analysis: Use 'shannon analyze' to transform raw specification documents into detailed 8D complexity reports and structured phase plans.
  • Rapid Feature Prototyping: Execute 'shannon do' to quickly generate boilerplate code, REST APIs, or specific functional modules using natural language instructions.
  • Autonomous Task Execution: Deploy 'shannon exec' for end-to-end implementation tasks that require 3-tier validation and automated git version control.
  • Complex Project Orchestration: Utilize 'shannon wave' to manage multi-agent workflows for large-scale implementations based on previously analyzed project specs.
  • Performance & Cost Monitoring: Leverage the real-time dashboard and built-in analytics to track execution sessions, optimize token costs, and manage context-aware development.
nameusing-shannon-cli
descriptionUse when starting work with Shannon CLI or need to understand available commands - introduces shannon analyze, wave, do, exec commands, explains when to use each, guides installation and basic workflows

Using Shannon CLI

Overview

Shannon CLI provides programmatic access to Shannon Framework with added intelligence (caching, analytics, cost optimization, context awareness).

Core Commands

shannon analyze - Analyze specifications

  • When: Have a spec/requirements document
  • Output: 8D complexity, domains, phase plan
  • Example: shannon analyze project_spec.md

shannon wave - Multi-agent wave execution

  • When: Implementing from analyzed spec
  • Uses: Shannon Framework wave-orchestration
  • Example: shannon wave "implement auth system"

shannon do - Execute tasks (V5)

  • When: Create files, implement features, fix bugs
  • Uses: Shannon Framework exec skill
  • Example: shannon do "create REST API with users"

shannon exec - Autonomous execution (V3.5)

  • When: Need validation + git automation
  • Uses: CompleteExecutor with 3-tier validation
  • Example: shannon exec "add tests for API"

Quick Start

# Install
pip install shannon-cli

# Analyze a spec
shannon analyze spec.md

# Execute a task
shannon do "create hello.py"

# With real-time dashboard
shannon do "create app" --dashboard

Command Selection

Need Use
Analyze requirements shannon analyze
Implement from spec shannon wave
Create files/features shannon do
With validation/git shannon exec

Features

  • Caching: Automatic (7-30 day TTL)
  • Cost Optimization: Auto model selection
  • Analytics: Session tracking in SQLite
  • Context: Project-aware analysis (after onboarding)
  • Dashboard: Real-time execution monitoring