ao-forge

AO-Forge

"🔥 AO-Forge: Your AI-powered CLI companion for building, managing, and deploying AO smart contracts with Next.js, Nuxt.js, and Svelte integration."

Documentation

• Quick Start Guide — Get up and running in minutes
• CLI Reference — Complete command documentation and options

Features

• 🚀 Quick project scaffolding
• 🔄 Multiple framework support (Next.js, Nuxt.js, Svelte)
• 📦 Automatic dependency installation
• 🎯 Git repository initialization
• 💻 Interactive CLI interface
• ⚡️ Built with TypeScript
• 🖥️ Development Server Integration
• 🤖 AI-Powered Code Generation
• 🔨 Simple Build System
• ⚙️ Configuration Management
• 🔧 AO Process Management

Installation

# Using npm
npm install -g ao-forge

# Using pnpm (recommended)
pnpm add -g ao-forge

# Or use directly with npx
npx ao-forge init my-app

Quick Start

See the Quick Start Guide for step-by-step instructions.

CLI Usage

See the CLI Reference for all commands, options, and advanced usage.

AI-Powered Development

Forge includes advanced AI capabilities for AO development. See the AI Commands section in the CLI Reference for details and examples.

Plugin System

Forge supports a plugin system for extending functionality. See Plugins.

Project Structure

my-app/
├── README.md
├── node_modules/
├── package.json
├── ao.config.yml      # AO configuration file
├── tsconfig.json
└── [framework-specific-files]
├── ao/               # For Nuxt.js projects
│   └── *.lua
└── src/             # For Next.js projects
    └── ao/
        └── *.lua

Configuration (ao.config.yml)

The configuration file is now fully documented in the CLI Reference. Use the provided template as a starting point.

Development

# Clone the repository
git clone https://github.com/Utitofon-Udoekong/forge-ao.git
cd forge-ao

# Install dependencies
pnpm install

# Build the project
pnpm build

# Link for local testing
pnpm run link:global

# Test the CLI
ao-forge init test-app

# Unlink when done
pnpm run unlink:global

Development Scripts

pnpm dev           # Watch mode
pnpm build         # Build project
pnpm test:cli      # Test CLI directly
pnpm link:global   # Link globally
pnpm unlink:global # Unlink global installation

Running AO Processes

You can manage AO processes using Forge commands or the AOS CLI directly:

# Using ao-forge commands
ao-forge process start -n "my-process"
ao-forge process stop
ao-forge process list

# Or use AOS CLI directly
npm i -g https://get_ao.g8way.io
aos [process-name] --load ./ao/contract.lua

Contributing

• Fork the repository
• Create your feature branch (git checkout -b feature/amazing-feature)
• Commit your changes (git commit -m 'Add amazing feature')
• Push to the branch (git push origin feature/amazing-feature)
• Open a Pull Request

License

MIT License - see the LICENSE file for details

Support

For support, please open an issue on GitHub.