@atakora/cli

Command-line interface for Atakora - the type-safe Infrastructure as Code framework for Azure.

Overview

The @atakora/cli package provides command-line tools for:

• Scaffolding new Atakora projects
• Synthesizing ARM templates from TypeScript
• Deploying infrastructure to Azure
• Managing multi-package workspaces
• Validating infrastructure code

Installation

# Install globally
npm install -g @atakora/cli

# Or use with npx
npx @atakora/cli <command>

Quick Start

# Create a new project
atakora init my-azure-project

# Navigate to the project
cd my-azure-project

# Synthesize ARM templates
atakora synth

# Deploy to Azure
atakora deploy

Available Commands

Project Management

# Initialize a new Atakora project
atakora init <project-name>

# Add a new package to workspace
atakora add <package-name>

Infrastructure Operations

# Synthesize ARM templates
atakora synth [package]

# Deploy infrastructure
atakora deploy [package]

# Validate infrastructure
atakora validate [package]

# Destroy infrastructure
atakora destroy [package]

Utility Commands

# List all packages
atakora list

# Show project information
atakora info

# Display help
atakora help [command]

Documentation

For complete documentation, see:

• CLI Reference
• Getting Started Guide
• Deployment Guide
• Multi-Package Workspaces

Project Templates

The CLI includes project templates for quick scaffolding:

• Root workspace configuration
• Package structure
• TypeScript configuration
• Example infrastructure code
• Git ignore patterns

See CLI Templates Reference for details.

Requirements

• Node.js 14.0.0 or higher
• npm 7.0.0 or higher
• Azure CLI (for deployment commands)

License

ISC