info command
Display detailed information about your AO-powered application project.
Syntax
ao-forge info [options]
Options
| Option | Description | Default |
|---|---|---|
--json | Output in JSON format | false |
--yaml | Output in YAML format | false |
--verbose | Show detailed information | false |
--project | Show project-specific information | false |
--dependencies | Show dependency information | false |
--processes | Show AO process information | false |
--help | Show help information | - |
Examples
Basic Usage
# Show project information
ao-forge info
# Show detailed information
ao-forge info --verbose
# Output in JSON format
ao-forge info --json
Advanced Usage
# Show project-specific information
ao-forge info --project
# Show dependency information
ao-forge info --dependencies
# Show AO process information
ao-forge info --processes
# Output in YAML format
ao-forge info --yaml
Project Information
Basic Project Info
# Show basic project information
ao-forge info
# Output example:
# Project: my-ao-app
# Version: 1.0.0
# Framework: Next.js 15.0.0
# Package Manager: pnpm 8.6.10
# Node.js: 18.17.0
# AO Environment: testnet
Detailed Project Info
# Show detailed project information
ao-forge info --verbose
# Output example:
# Project Information:
# Name: my-ao-app
# Version: 1.0.0
# Description: My AO-powered application
# Framework: Next.js 15.0.0
# Package Manager: pnpm 8.6.10
# Node.js: 18.17.0
# AO Environment: testnet
# Gateway: https://arweave.net
# Wallet: Connected
# Processes: 2 active
# Dependencies: 45 packages
# Build Status: Ready
JSON Output
# Output in JSON format
ao-forge info --json
# Output example:
# {
# "project": {
# "name": "my-ao-app",
# "version": "1.0.0",
# "description": "My AO-powered application",
# "framework": "Next.js 15.0.0",
# "packageManager": "pnpm 8.6.10",
# "nodeVersion": "18.17.0",
# "aoEnvironment": "testnet",
# "gateway": "https://arweave.net",
# "wallet": "Connected",
# "processes": 2,
# "dependencies": 45,
# "buildStatus": "Ready"
# }
# }
Project-Specific Information
Project Configuration
# Show project configuration
ao-forge info --project
# Output example:
# Project Configuration:
# Name: my-ao-app
# Version: 1.0.0
# Description: My AO-powered application
# Framework: Next.js
# Package Manager: pnpm
# Lua Files: counter.lua, dao.lua
# Auto Start: false
# Ports:
# Dev: 3000
# Production: 3000
# Environment: development
Project Structure
# Show project structure
ao-forge info --project --structure
# Output example:
# Project Structure:
# my-ao-app/
# ├── README.md
# ├── package.json
# ├── ao.config.yml
# ├── tsconfig.json
# ├── next.config.js
# ├── tailwind.config.js
# ├── src/
# │ ├── app/
# │ │ ├── layout.tsx
# │ │ ├── page.tsx
# │ │ └── globals.css
# │ └── ao/
# │ ├── counter.lua
# │ └── dao.lua
# └── public/
# └── favicon.ico
Dependency Information
Package Dependencies
# Show dependency information
ao-forge info --dependencies
# Output example:
# Dependencies:
# Production: 25 packages
# Development: 20 packages
# Total: 45 packages
#
# Key Dependencies:
# next: 15.0.0
# react: 18.2.0
# typescript: 5.0.0
# tailwindcss: 3.3.0
# @solana/kit: 1.0.0
# aos: 1.0.0
Dependency Details
# Show detailed dependency information
ao-forge info --dependencies --verbose
# Output example:
# Dependencies:
# Production (25):
# next: 15.0.0
# react: 18.2.0
# react-dom: 18.2.0
# typescript: 5.0.0
# tailwindcss: 3.3.0
# @solana/kit: 1.0.0
# aos: 1.0.0
# ...
#
# Development (20):
# @types/node: 20.0.0
# @types/react: 18.2.0
# eslint: 8.0.0
# prettier: 3.0.0
# ...
AO Process Information
Process Status
# Show AO process information
ao-forge info --processes
# Output example:
# AO Processes:
# Active: 2
# Total: 3
#
# Processes:
# counter: Running (PID: 12345)
# dao: Running (PID: 12346)
# nft: Stopped
Process Details
# Show detailed process information
ao-forge info --processes --verbose
# Output example:
# AO Processes:
# Active: 2
# Total: 3
#
# Process Details:
# counter:
# Status: Running
# PID: 12345
# Memory: 15.2 MB
# CPU: 2.1%
# Uptime: 2h 30m
# Messages: 1,234
# Errors: 0
#
# dao:
# Status: Running
# PID: 12346
# Memory: 22.8 MB
# CPU: 1.8%
# Uptime: 2h 30m
# Messages: 856
# Errors: 0
#
# nft:
# Status: Stopped
# PID: N/A
# Memory: 0 MB
# CPU: 0%
# Uptime: 0s
# Messages: 0
# Errors: 0
Environment Information
Runtime Environment
# Show runtime environment
ao-forge info --environment
# Output example:
# Runtime Environment:
# Node.js: 18.17.0
# npm: 9.6.7
# pnpm: 8.6.10
# AOS CLI: 1.0.0
# OS: Linux 5.15.153.1-microsoft-standard-WSL2
# Architecture: x64
# Memory: 8.0 GB
# CPU: 4 cores
AO Environment
# Show AO environment
ao-forge info --ao-environment
# Output example:
# AO Environment:
# Network: testnet
# Gateway: https://arweave.net
# Wallet: Connected (my-wallet.json)
# Balance: 0.5 AR
# Processes: 2 active
# Messages: 2,090 total
Build Information
Build Status
# Show build information
ao-forge info --build
# Output example:
# Build Information:
# Status: Ready
# Last Build: 2024-01-01T12:00:00Z
# Build Time: 2m 30s
# Output Size: 15.2 MB
# Optimizations: Enabled
# Source Maps: Enabled
Build Details
# Show detailed build information
ao-forge info --build --verbose
# Output example:
# Build Information:
# Status: Ready
# Last Build: 2024-01-01T12:00:00Z
# Build Time: 2m 30s
# Output Size: 15.2 MB
# Optimizations: Enabled
# Source Maps: Enabled
# Chunks: 12
# Assets: 45
# Dependencies: 25
Performance Information
Performance Metrics
# Show performance information
ao-forge info --performance
# Output example:
# Performance Metrics:
# Memory Usage: 45.2 MB
# CPU Usage: 3.2%
# Disk Usage: 125.8 MB
# Network: 2.1 MB/s
# Response Time: 120ms
Resource Usage
# Show resource usage
ao-forge info --resources
# Output example:
# Resource Usage:
# Memory: 45.2 MB / 8.0 GB (0.6%)
# CPU: 3.2% / 400% (0.8%)
# Disk: 125.8 MB / 500 GB (0.03%)
# Network: 2.1 MB/s
Configuration Information
Configuration Files
# Show configuration information
ao-forge info --config
# Output example:
# Configuration Files:
# ao.config.yml: Present
# package.json: Present
# tsconfig.json: Present
# next.config.js: Present
# tailwind.config.js: Present
Configuration Details
# Show detailed configuration
ao-forge info --config --verbose
# Output example:
# Configuration Details:
# ao.config.yml:
# Name: my-ao-app
# Version: 1.0.0
# Framework: nextjs
# Package Manager: pnpm
# Lua Files: counter.lua, dao.lua
# Auto Start: false
# Ports: 3000
#
# package.json:
# Name: my-ao-app
# Version: 1.0.0
# Dependencies: 25
# Scripts: 8
Information Formats
YAML Output
# Output in YAML format
ao-forge info --yaml
# Output example:
# project:
# name: my-ao-app
# version: 1.0.0
# description: My AO-powered application
# framework: Next.js 15.0.0
# packageManager: pnpm 8.6.10
# nodeVersion: 18.17.0
# aoEnvironment: testnet
# gateway: https://arweave.net
# wallet: Connected
# processes: 2
# dependencies: 45
# buildStatus: Ready
Custom Format
# Custom output format
ao-forge info --format custom
# Output specific sections
ao-forge info --sections project,dependencies
Information Filtering
Filter by Category
# Show only project information
ao-forge info --project-only
# Show only dependency information
ao-forge info --dependencies-only
# Show only process information
ao-forge info --processes-only
Filter by Status
# Show only active processes
ao-forge info --processes --active-only
# Show only running processes
ao-forge info --processes --running-only
Information Troubleshooting
Common Issues
- Project not found
Error: Project not found Solution: Run from project directory or use --path - Configuration not found
Error: Configuration file not found Solution: Run 'ao-forge init' to create project - Process information not available
Error: Process information not available Solution: Start processes with 'ao-forge dev'
Information Best Practices
Using Info Effectively
- Use basic info for quick project overview
- Use verbose info for detailed analysis
- Use JSON/YAML for programmatic access
- Use specific filters for focused information
- Use info regularly to monitor project status
Information Management
- Keep information up to date
- Use consistent formatting across outputs
- Include relevant details in verbose mode
- Make information accessible to all users
- Use appropriate formats for different needs
Related Commands
ao-forge version- Show version informationao-forge --help- Show help informationao-forge config- Manage configurationao-forge process- Manage AO processes
Table of Contents
- Syntax
- Options
- Examples
- Project Information
- Project-Specific Information
- Dependency Information
- AO Process Information
- Environment Information
- Build Information
- Performance Information
- Configuration Information
- Information Formats
- Information Filtering
- Information Troubleshooting
- Information Best Practices
- Related Commands
