🚀 Quick Start Guide¶

This guide will help you get started with shapi in just a few minutes.

Prerequisites¶

• Ollama with Mistral:7b model installed (see Installation Guide)
• Python 3.8 or higher
• Basic familiarity with command line

Your First Architecture¶

1. Start with a simple command:

   shapi "I need a REST API for a todo app with user authentication"
   

2. Interactive Mode:

   shapi shell
   

   Then type your requirements in the interactive prompt.

Basic Commands¶

Generate Architecture¶

# Basic usage
shapi "Your architecture requirements here"

# Specify output format (default: markdown)
shapi --format json "Your requirements"

# Save output to a file
shapi "Your requirements" > architecture.md

Interactive Shell¶

# Start interactive shell
shapi shell

# In the shell:
> help                 # Show available commands
> clear               # Clear screen
> exit                # Exit the shell

Example Workflow¶

1. Define your requirements:

   shapi "I need a REST API for a blog with user authentication and comments"
   

2. Review the generated architecture in the terminal output

3. Generate implementation code:

   shapi "Generate implementation code for the blog API"
   

4. Save the output to a file for future reference:

   shapi "Generate implementation code for the blog API" > blog_implementation.md
   

Advanced Example¶

1. Generate a microservices architecture:

   shapi "I need a microservices architecture for an e-commerce platform with:
   - Product catalog
   - User authentication
   - Shopping cart
   - Payment processing
   - Order management"
   

2. Review the generated architecture

3. Refine and iterate:

   shapi "Add Redis caching to the previous architecture"
   

Next Steps¶

• Explore more features of shapi
• Check out the API Reference for advanced usage
• Review the installation guide for configuration options

Getting Help¶

• Run shapi --help for command-line options
• Open an issue for bugs or feature requests