Installation
Prerequisites
Section titled “Prerequisites”Before installing Agent Cloud, make sure you have:
Node.js 18+
Section titled “Node.js 18+”Agent Cloud is built with TypeScript and requires Node.js version 18 or higher.
# Check your Node.js versionnode --version
# If you need to install or update Node.js:# Using nvm (recommended)nvm install 18nvm use 18
# Or download from https://nodejs.orgA Cloud CLI (at least one)
Section titled “A Cloud CLI (at least one)”You need the CLI tool for whichever cloud provider you want to deploy to:
| Provider | CLI Tool | Installation Guide |
|---|---|---|
| AWS | aws CLI v2 | AWS CLI Install Guide |
| Google Cloud | gcloud SDK | Google Cloud SDK Install |
| Azure | az CLI | Azure CLI Install |
You can install all three or just the one you plan to use. The cloud-agent init command will detect which CLIs are available.
An AI API Key (optional for analysis, required for deploy)
Section titled “An AI API Key (optional for analysis, required for deploy)”The analyze command works without any API key using local-only analysis. However, deploy and analyze --ai require one of:
- Google Gemini API key (free tier available) — get one at Google AI Studio
- OpenAI API key (paid) — get one at OpenAI Platform
Install Agent Cloud
Section titled “Install Agent Cloud”From npm (recommended)
Section titled “From npm (recommended)”npm install -g agent-cloudAfter installation, the cloud-agent command will be available globally.
From source
Section titled “From source”If you want to run from source or contribute:
# Clone the repositorygit clone https://github.com/intojhanurag/agent-cloud.gitcd agent-cloud
# Install dependenciesnpm install
# Build the projectnpm run build
# Link the CLI globallynpm linkYou can also run directly from source without building:
# Run with tsx (TypeScript executor)npm run cli
# Or explicitlynpx tsx src/cli/index.tsVerify Installation
Section titled “Verify Installation”# Check that the CLI is availablecloud-agent --version
# Run the setup wizardcloud-agent initThe init command will:
- Set up your AI API key — prompts you to enter a Gemini or OpenAI key and saves it to
.env - Detect cloud CLIs — checks for
aws,gcloud, andazand reports which are installed - Set default preferences — lets you pick a default cloud provider
Environment Setup
Section titled “Environment Setup”Using a .env file
Section titled “Using a .env file”Create a .env file in your project directory (or wherever you run cloud-agent):
# AI provider (pick one)GOOGLE_GENERATIVE_AI_API_KEY=your-gemini-key-here# OROPENAI_API_KEY=your-openai-key-hereAgent Cloud loads .env automatically via dotenv.
Using shell environment variables
Section titled “Using shell environment variables”You can also export the key in your shell profile:
# In ~/.bashrc or ~/.zshrcexport GOOGLE_GENERATIVE_AI_API_KEY=your-gemini-key-hereWhat’s Next
Section titled “What’s Next”Once installed, head to the Quick Start guide to deploy your first project.