megaport-cli

Megaport CLI

[!CAUTION] The Megaport CLI tool is currently an unsupported alpha, we're excited for feedback but please know that functionallity and features may change drastically, and there may be bugs.

Overview

The Megaport CLI provides a command-line interface for managing Megaport resources and services. It allows users to interact with the Megaport API directly from their terminal.

Before using this CLI, please ensure you read and accept Megaport's Terms and Conditions and Acceptable Use Policy.

For API details, consult the Megaport API Documentation.

Installation

# Install using Go
go install github.com/megaport/megaport-cli@latest

# Verify installation
megaport --version

Shell Completion

The CLI supports shell completion for bash, zsh, fish, and PowerShell:

# Bash (Linux)
megaport completion bash > /etc/bash_completion.d/megaport

# Bash (macOS with Homebrew)
megaport completion bash > $(brew --prefix)/etc/bash_completion.d/megaport

# Zsh
megaport completion zsh > "${fpath[1]}/_megaport"

# Fish
megaport completion fish > ~/.config/fish/completions/megaport.fish

# PowerShell
megaport completion powershell > megaport.ps1

Environment Support

The CLI supports different Megaport environments:

• Production (default)
• Staging
• Development

Specify the environment using the --env flag or MEGAPORT_ENVIRONMENT variable.

Configuration

Configure your CLI credentials using environment variables.

# Using environment variables
export MEGAPORT_ACCESS_KEY=<your-access-key>
export MEGAPORT_SECRET_KEY=<your-secret-key>
export MEGAPORT_ENVIRONMENT=<environment>  # production, staging, or development

Available Commands

Resource Management

• locations: List and search Megaport locations
• ports: Manage Megaport ports
• mcr: Manage Megaport Cloud Routers
• mve: Manage Megaport Virtual Edge instances
• vxc: Manage Virtual Cross Connects
• partners: List and search partner ports
• servicekeys: Manage service keys

Output Formats

All commands support multiple output formats:

• --output table (default)
• --output json
• --output csv

Examples

# List all locations
megaport locations list

# Get port details
megaport ports get PORT_UID --output json

# List partner ports with filtering
megaport partners list \
  --product-name "AWS Direct Connect" \
  --connect-type "AWSHC" \
  --output table

# Create a service key
megaport servicekeys create \
  --product-uid PRODUCT_UID \
  --description "My Service Key" \
  --max-speed 1000

Contributing

Contributions via pull request are welcome. Familiarize yourself with these guidelines to increase the likelihood of your pull request being accepted.

All contributions are subject to the Megaport Contributor Licence Agreement.

The CLA clarifies the terms of the Mozilla Public Licence 2.0 used to Open Source this respository and ensures that contributors are explictly informed of the conditions. Megaport requires all contributors to accept these terms to ensure that the Megaport Terraform Provider remains available and licensed for the community.

When you open a Pull Request, all authors of the contributions are required to comment on the Pull Request confirming acceptance of the CLA terms. Pull Requests can not be merged until this is complete.

Megaport users are also bound by the Acceptable Use Policy.

Support

• Open Issues
• API Documentation
• Megaport Website