# cloudmux

**Repository Path**: yunionio/cloudmux

## Basic Information

- **Project Name**: cloudmux
- **Description**: Cloudmux is a unified golang library to access multicloud/hybridcloud API
- **Primary Language**: Go
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-05-30
- **Last Updated**: 2025-11-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# CloudMuX

CloudMuX is an in-process Multi-Cloud Library written entirely in Golang. It provides consistent interfaces to access OpenAPIs of various cloud providers. Cloudpods CMP service is built upon CloudMux.

## Command line tool -- cmx

cmx is the command line tool based on CloudMux. cmx is a compact utility to access various clouds.

### Complile

```bash
$ make cmd/cmx
```

### Build Image

```bash
TAG=v3.10.4 GOOS=linux ARCH=amd64 REGISTRY=registry.cn-beijing.aliyuncs.com/<name> make image cloudmux
```

### Example

1. List regions

```bash
# Aliyun
$ ./_output/bin/cmx --provider Aliyun  --access-key $your_access_key --secret $your_secret region-list 

# Aws
$ ./_output/bin/cmx --provider Aws --cloud-env ChinaCloud  --access-key $your_access_key --secret $your_secret --debug region-list

# Azure
$ ./_output/bin/cmx --provider Azure --cloud-env AzurePublicCloud \
    --access-key $your_directory_id/$your_subscription_id \
    --secret $your_app_id/$your_app_key \
    region-list
```

2. List zones

```bash
# Aliyun
$ ./_output/bin/cmx --provider Aliyun  --access-key $your_access_key --secret $your_secret zone-list
```

3. List VM instances

```bash
# Aliyun
$ ./_output/bin/cmx --provider Aliyun --region ap-southeast-1 --access-key $your_access_key  --secret $your_secret  instance-list --zone ap-southeast-1a
```