CLI reference¶
This page is generated from the Cobra command tree. Do not edit it by hand.
Global options¶
--config string configuration file (default "magelift.yaml")
--env string environment name
--no-interaction never prompt for input
-o, --output string output format: table, json, or yaml (default "table")
--preview-branch string source branch metadata for a preview identity
--preview-commit string commit digest metadata for a preview identity
--preview-domain string domain metadata for a preview identity
--preview-generation uint deployment generation for a preview identity
--preview-number int pull-request number for a preview identity
--preview-repository string canonical repository slug for a pull-request preview
-v, --verbose count increase diagnostic verbosity
-y, --yes confirm destructive actions
magelift audit¶
Export a control-posture matrix with evidence pointers and no secret values
magelift benchmark¶
Measure a Magento workload for preset sizing
magelift benchmark run¶
Options:
--cache string cache implementation and version under test
--catalog string benchmark catalog name
--catalog-revision string benchmark catalog revision or commit
--concurrency int number of concurrent workers (default 10)
--database string database engine and version under test
--duration duration measurement duration (default 30s)
--edition string Magento edition: open-source or commerce (default "open-source")
--magento-version string Magento version under test
--mix string request mix as comma-separated path=weight entries (default "/=100")
--php-version string PHP version under test
--queue string queue implementation and version under test
--search string search engine and version under test
--url string Magento base URL to measure
magelift bootstrap¶
Prepare this cloud account for Magento
Options:
--access-log-bucket string existing AWS log bucket (AWS only)
--apply-ci-permissions apply reviewed GCP CI IAM grants (GCP only)
--configure-github write allowlisted GitHub repository variables after CI permissions are applied (GCP only)
--github-owner string optional GitHub owner for Actions deploys
--github-repo string optional GitHub repository for Actions deploys
magelift build¶
Build an immutable Magento application image
Options:
--builder-image string advanced builder image override (pair with --runtime-image; registry digest required with --push)
--export-recipe string export the bundled build recipe without building or publishing
--image string target image reference for a pushed build
--platform strings target platform, repeatable or comma-separated
--push push the image and publish build attestations
--runtime-image string advanced runtime image override (pair with --builder-image; registry digest required with --push)
--source-url string HTTPS Git source URL used for provenance
magelift cache-flush¶
Run the Magento cache-flush operation on the web workload
magelift certification¶
Inspect provider cells and verify acceptance evidence
magelift certification cells¶
Expand one provider target into architecture cells
Options:
--edition string Magento edition: open-source or commerce (default "open-source")
--preset string environment preset (default "preview")
--release string exact Adobe Commerce release (default "2.4.9")
--target string target ID, such as aws/ecs-fargate
magelift certification docs¶
Generate source-dated release documents from the catalog and sealed evidence
Options:
--evidence-file string sealed JSONL evidence file to include
--output-dir string directory for generated Markdown documents
--run-id string run ID when the evidence file contains more than one run
magelift certification plan¶
Print a side-effect-free certification execution plan
Options:
--edition string Magento edition: open-source or commerce (default "open-source")
--preset string environment preset (default "preview")
--release string exact Adobe Commerce release (default "2.4.9")
--target string target ID, such as gcp/gke-standard
magelift certification seal¶
Seal unsealed acceptance candidates with the core evidence contract
Options:
--file string unsealed JSONL evidence candidates
--output-file string sealed JSONL output file (default: input with .sealed.jsonl suffix)
magelift certification targets¶
List provider architecture descriptors
magelift certification verify¶
Verify sealed JSONL acceptance evidence
Options:
--file string JSONL evidence file
--required-cell stringArray required stable cell ID; repeat for multiple cells
--run-id string run ID when the file contains more than one run
magelift ci¶
Generate and validate GitHub Actions workflows
magelift ci generate¶
Generate the GitHub Actions workflow
Options:
--magelift-version string MageLift release version installed by CI (default "dev")
--path string workflow output path
--replace replace an existing workflow that differs from the MageLift template
magelift ci validate¶
Validate the GitHub Actions workflow
Options:
--check-template require the workflow to match the current MageLift template exactly
--magelift-version string MageLift release version installed by CI (default "dev")
--path string workflow output path
magelift cleanup¶
Reconcile interrupted environment and acceptance cleanup
magelift cleanup claim¶
Record an owned resource before creating it
Options:
--identity string provider identity if already known
--kind string resource kind, such as rdb-instance
--ledger string path to the cleanup ledger JSON file
--marker string ownership marker
--name string provider name used before the identity exists
--profile string local CLI profile name
--project string provider project or account
--provider string provider ID, such as scaleway
--rank int deletion rank; snapshots are lower than source instances
--region string provider region
--role string resource role: source, restore, or snapshot
--run-id string stable run identity
magelift cleanup plan¶
Show owned resources a reconcile would delete
Options:
--dir string directory of cleanup ledger JSON files
--ledger string path to one cleanup ledger JSON file
magelift cleanup reconcile¶
Delete claimed resources left behind by an interrupted run
Options:
--dir string directory of cleanup ledger JSON files
--ledger string path to one cleanup ledger JSON file
magelift cleanup record¶
Bind a provider identity after create succeeds
Options:
--identity string provider identity returned by create
--kind string resource kind, such as rdb-instance
--ledger string path to the cleanup ledger JSON file
--name string claimed provider name
magelift compatibility¶
Inspect the Adobe and MageLift compatibility catalog
magelift compatibility catalog¶
List release and service requirements
magelift compatibility validate¶
Validate one catalog service choice
Options:
--component string catalog component, such as database or search
--option string service option, such as mysql or opensearch
--release string exact Adobe Commerce release, such as 2.4.8-p5
--version string service version when the catalog lists versions
magelift completion¶
Generate shell completion
magelift config¶
Inspect and migrate configuration
magelift config effective¶
Print effective configuration with provenance
magelift config explain¶
Explain where an effective value came from
magelift config migrate¶
Migrate configuration to the current schema
magelift config validate¶
Validate configuration
magelift cost¶
Describe the selected environment's cost inputs
Options:
--budget read the provider budget definition and alert thresholds when supported
--live query current provider on-demand prices when the adapter supports it
magelift cron-run¶
Run the Magento cron-run operation on the web workload
magelift deploy¶
Deploy the selected environment
Options:
--ack-maintenance-drain attest backup, maintenance mode, and drained writers for production schema risk (see docs/operations.md)
--digest string override the configured immutable image digest
--infra-only update the infrastructure graph only (skip Magento migrate/health)
magelift destroy¶
Destroy the selected environment
Options:
--destroy-backups also destroy leftover provider backups after the environment is gone; GCP Cloud SQL leftovers are deleted even when the backup policy is disposable, AWS snapshots are still refused
--skip-lock skip the provider distributed state lock (acceptance cleanup only)
magelift doctor¶
Check this project and print the next Magelift command
Options:
--export string write an allowlisted local diagnostic JSON report to a new file (mode 0600)
--install-dependencies install missing allowlisted dependencies after confirmation
--local skip cloud credential probes; still run local toolchain checks
magelift edge¶
Manage explicitly configured external edge services
magelift edge apply¶
Apply the configured Fastly service and domains
magelift edge destroy¶
Delete only Fastly resources owned by this project environment
magelift edge plan¶
Print the Fastly edge plan without changing provider state
magelift edge purge¶
Invalidate or purge the selected environment's Magento-facing edge cache
magelift env¶
MageLift env commands
magelift env create¶
Add an environment overlay to magelift.yaml
Options:
--account string AWS account ID
--branches strings Git branches mapped to this environment
--class string environment class
--domain string environment domain
--dump string path to a MySQL dump to seed after first deploy (ADR 0010)
--expires-at string preview expiration as RFC3339
--monthly-budget-cents int maximum monthly AWS budget in cents
--preset string infrastructure preset
--protection protect destructive operations
magelift env destroy¶
Destroy an environment and remove its configuration overlay
Options:
--destroy-backups also destroy leftover provider backups after the environment is gone; GCP Cloud SQL leftovers are deleted even when the backup policy is disposable, AWS snapshots are still refused
magelift env dump¶
Create a Magento database dump from a live environment and write it locally
Options:
--sanitize hash mailbox addresses in the dump (not certified anonymous)
--to string local .sql or .sql.gz path to write (required)
magelift env import-dump¶
Import the environment seedDump into the target database
magelift env list¶
List configured environments
magelift env media-export¶
Download the environment media bucket tree to a local directory
Options:
magelift env media-sync¶
Upload a local media tree into the environment media bucket (merge)
Options:
magelift env protect¶
Enable or disable destructive-operation protection
Options:
magelift env status¶
Show environment overlay status including seed dump journal
magelift env sweep¶
Destroy expired preview environments
Options:
--before string treat environments expiring at or before this RFC3339 time as expired
--dry-run report expired environments without changing infrastructure or configuration
magelift env ui¶
Print a time-limited management UI tunnel without starting it
Options:
magelift evidence¶
Export reconstructable production change evidence without secret values
magelift exec¶
Run a command on a Magento workload
Options:
--container string container name (default "web")
--service string logical service: web or cron (default "web")
--session-only print the resolved session command without starting it
magelift extensions¶
Inspect explicitly registered provider extensions
magelift extensions list¶
List extension provenance and targets
magelift health¶
Check configuration or deployed stack health evidence
Options:
magelift history¶
List the local release journal
magelift init¶
Create a starter magelift.yaml for Magento's PHP storefront
Options:
--config-out string write generated YAML to PATH for review (default: --config path)
--from-acc generate magelift.yaml from Adobe Commerce Cloud config
--from-upsun generate magelift.yaml from Upsun / Platform.sh config
--provider string starter provider: aws or gcp (default "gcp")
magelift local¶
Run the local Magento environment
magelift local down¶
Run local Compose down
magelift local exec¶
Run a command in a local Compose service
Options:
magelift local init¶
Create the local Docker Compose environment
magelift local logs¶
Run local Compose logs
Options:
magelift local reset¶
Run local Compose reset
magelift local seed¶
Install Magento into the local Compose services
Options:
--admin-email string Magento administrator email (default "admin@example.test")
--admin-firstname string Magento administrator first name (default "MageLift")
--admin-lastname string Magento administrator last name (default "Local")
--admin-user string Magento administrator username (default "admin")
--backend-frontname string Magento administrator URL segment (default "admin")
--base-url string local Magento base URL (default "http://localhost:8080/")
magelift local status¶
Run local Compose status
magelift local up¶
Run local Compose up
Options:
magelift login¶
Verify cloud credentials for the selected environment
magelift logs¶
Read recent Magento application logs
Options:
--filter string provider log filter pattern
--limit int maximum number of events (default 100)
--service string log service: web, deploy, or cron (default "web")
--since string duration or RFC3339 start time (default "15m")
--until string optional duration or RFC3339 end time
magelift outputs¶
Read outputs from the selected environment
magelift preview¶
Preview Magento environment changes without applying
magelift promote¶
Record a signed image digest as a release
Options:
--certificate-identity string advanced: expected signing identity; omit to use the current login
--certificate-oidc-issuer string advanced: expected signing issuer; omit to use the current login
--digest string signed registry digest reference
--from string source environment
magelift providers¶
Download and verify provider plugins
magelift providers install¶
Download and verify the providers named by magelift.yaml
Options:
--cache-dir string provider cache directory (default: user cache)
--lockfile string provider lockfile path (default: ./magelift.providers.lock, then beside the CLI)
--version string release tag to bootstrap the lockfile from when none exists (default: the CLI version)
magelift queue-status¶
Run the Magento queue-status operation on the web workload
magelift reindex¶
Run the Magento reindex operation on the web workload
magelift rollback¶
Deploy a previous signed digest as a new release
Options:
--ack-forward-only acknowledge that rollback never reverses database migrations
--to-sequence int previous release sequence
magelift secret¶
MageLift secret commands
magelift secret list¶
List application secret names
magelift secret remove¶
Schedule an application secret for deletion
magelift secret set¶
Create or update an application secret
Options:
magelift sign¶
Sign a pushed image digest using the current cloud login
Options:
--digest string registry digest reference
--identity-token-file string advanced: identity token file; omit to use the current gcloud or CI login
magelift skills¶
List, install, and verify MageLift agent skills
magelift skills install¶
Install bundled skills for an agent
Options:
--agent string agent path: codex, claude, cursor, or generic (default "generic")
--backend string installer backend: direct or skills-cli (default "direct")
--mode string installation mode: auto, copy, or symlink (default "auto")
--replace replace an unrelated skill already at the destination
--scope string installation scope: project or global (default "project")
-s, --skill strings install only the named skill; repeat the flag for more than one
magelift skills list¶
List bundled first-party skills
magelift skills verify¶
Verify installed first-party skills without executing them
Options:
--agent string agent path: codex, claude, cursor, or generic (default "generic")
--scope string installation scope: project or global (default "project")
-s, --skill strings verify only the named skill; repeat the flag for more than one
magelift ssh¶
Open a shell on a Magento workload
Options:
--command string shell command to run (default "/bin/sh")
--container string container name (default "web")
--service string logical service: web or cron (default "web")
--session-only print the resolved session command without starting it
magelift state¶
MageLift state commands
magelift state backup¶
Create a versioned stack-state backup
magelift state restore¶
Restore stack state from a versioned backup
magelift state status¶
Show the deployment lock status
magelift state unlock¶
Remove a stale deployment lock
magelift status¶
Show the selected environment configuration
magelift tunnel¶
Forward a private Magento service to localhost
Options:
--local-port int local loopback port (defaults to the target port, or 8080 for app)
--remote-port int provider-side port (defaults to the target's verified service port)
--session-only print the resolved tunnel command without starting it
--target string private target: app, db, db-ui, queue, queue-ui, search, or search-ui (default "app")
magelift upgrade¶
Check for or install a signed MageLift CLI release
Options:
--check check for an update without replacing the executable
--version string install a specific release tag
magelift version¶
Print version information