@iga-pages/cli
v1.1.5
Published
A CLI tool for IGA Pages
Downloads
2,221
Readme
Overview
IGA Pages is a full-stack development and deployment platform powered by Volcengine IGA/DCDN. It supports static sites, server-side rendering, and serverless functions, delivering projects to a global edge network with zero infrastructure management.
@iga-pages/cli is the official command-line interface for IGA Pages, helping you manage projects, develop locally, and debug Functions from your terminal.
Prerequisites
To get started, create an account with Volcengine.
Installation
npm install -g @iga-pages/cliVerify the installation:
iga -v
iga -hCommands
iga login
Authenticate with your Volcengine account. The CLI supports two login methods:
- Browser-based OAuth — run
iga loginwith no flags to open a browser window and sign in with your Volcengine account. - Access Key / Secret Key — pass
--accessKeyand--secretKeyto log in directly with an AK/SK pair.
iga login # browser-based OAuth
iga login --accessKey <AK> --secretKey <SK> # AK/SK| Flag | Description |
| ------------- | ------------------------------------------- |
| --accessKey | Volcengine Access Key (skips browser login) |
| --secretKey | Volcengine Secret Key (skips browser login) |
iga switch
Switch to a different Volcengine account by re-running the login flow.
iga switchiga pages link
Link the current directory to an IGA Pages project. The CLI auto-detects a matching project by directory name, or lets you pick from your existing projects. If no project exists yet, it can create one (including GitHub-connected projects when a Git remote is detected).
iga pages link
iga pages link --format=json
iga pages link --project <project-id-or-name> --yes--format=json prints existing project choices, the directory-derived default project name, a matching project when one exists, and a suggested nextCommand. It does not create a project or write .iga/project.json.
--project links to an existing project without prompting. It matches ProjectID first, then ProjectName. If a name is ambiguous, pass the ProjectID from iga pages link --format=json.
iga pages deploy
Build and deploy the current project to the IGA Pages edge network. The CLI supports two deployment modes:
- Git-based — If a GitHub remote is detected and authorized, the platform pulls source code directly from the repository.
- Direct upload — Source files are zipped and uploaded when no Git provider is available.
For linked projects (see iga pages link), re-deployment is triggered automatically. For new projects, the CLI walks you through creation first.
iga pages deploy # deploy current projectiga pages dev
Start a local development server. The CLI reads the dev or start script from your package.json, injects the port automatically if the framework supports it, and falls back to framework defaults when no script is found.
iga pages dev # start on http://localhost:3000iga pages list
List recent deployments for the currently-linked project, or all projects in your account. Aliased as iga pages ls.
When run inside a linked directory (or with a project name/ID), it lists that project's recent deployments. Otherwise it lists every project in your account, so you can discover a name or ID to link or inspect.
iga pages list # linked project's deployments, or all projects
iga pages list my-project # a specific project's deployments (by name or ID)
iga pages ls --json # machine-readable output| Flag | Description |
| ---------------- | ------------------------------------------------------------------ |
| [project] | Project name or ID (defaults to the linked .iga/project.json) |
| --project <id> | Project name or ID (alias for the positional argument) |
| --json | Output machine-readable JSON |
iga pages env
Manage project-level environment variables for the linked IGA Pages project.
iga pages env list
iga pages env list --format=json
iga pages env add <name> --value <value> --yes
iga pages env update <name> --value <value> --yes
iga pages env remove <name> --yes
iga pages env pullenv list only shows variable names. --format=json returns env[].key and never prints values.
iga pages integration
Manage project integrations. The first supported integration is supabase with the volc_supabase product.
iga pages integration list
iga pages integration list --format=json
iga pages integration link supabase
iga pages integration link supabase --region <region> --format=json
iga pages integration link supabase \
--product volc_supabase \
--region <region> \
--resource <workspace-name-or-id> \
--branch <branch-name-or-id> \
--framework-prefix NEXT_PUBLIC_ \
--prefix APP_ \
--yes
iga pages integration unlink
iga pages integration unlink supabase --format=json
iga pages integration unlink supabase \
--product volc_supabase \
--resource <workspace-name-or-id> \
--branch <branch-name-or-id> \
--yes--format=json is intended for IDE and agent workflows. It returns structured choices when input is missing: regions, workspaces, branches, linked bindings, confirmation prompts, and nextCommand where applicable.
--framework-prefix and --prefix are written to integration tags as provided. Non-empty values must follow the Pages env key format: 1-63 characters, start with a letter, and contain only letters, numbers, or underscores. Pass an empty --framework-prefix to skip browser-exposed variables.
iga logout
Sign out of the currently logged-in Volcengine account.
iga logoutiga whoami
Display information about the currently authenticated account.
iga whoamiLicense
MIT © Beijing Volcano Engine Technology Co., Ltd.
