compshare-cli

CompShare CLI

Manage CompShare GPU compute and MiniMax H3 from the terminal with the compshare command.

Operating rules

• Use compshare --json ... for automation. Parse the single JSON document instead of terminal tables.
• Run compshare --json COMMAND --help before using an unfamiliar command or option. JSON help returns the current command, parameter and subcommand structure without requiring credentials.
• Put global options before the command group, for example compshare --json --profile production instance list --all.
• Inspect resources and prices before changing them. Use instance create --dry-run before a real create operation.
• Add --yes only when the user has authorized the mutation. Deletion, stopping, reinstalling, resizing and similar operations can require confirmation.
• Use explicit timeouts for creation, lifecycle waits and remote jobs. After a timeout, inspect the resource before retrying because the remote operation may still be running.
• Keep sensitive output redacted. Do not use --show-sensitive unless the user explicitly needs the raw password, IP, access URL or login command.
• Do not print, log or commit API credentials. Prefer an existing profile or environment variables over passing a private key on the command line.

Install and configure

pip install compshare-cli
pip install --upgrade compshare-cli

Configure a credential profile interactively:

compshare config --name default
compshare config list

For non-interactive environments, provide credentials through the process environment:

MiniMax H3 uses a separate model API key:

Select a named profile with --profile NAME. Use compshare config path to locate the configuration file and compshare config use NAME to change the default profile.

Discover current commands

Prefer the CLI's structured help over guessing flags:

Global options:

• --json: emit the stable machine-readable response envelope.
• --profile NAME: select a credential profile.
• --lang zh|en: select the output language; JSON error codes remain language-independent.
• --show-sensitive: reveal normally redacted fields; avoid by default.
• --version: print the CLI version.

Create an instance

Discover locations and images, then search legal specifications and real inventory:

--image makes instance search check real inventory. Without it, the command lists legal specifications only. Search does not filter CPU or memory; validate the exact CPU and memory combination with the create dry run.

Build and inspect the create plan without changing resources:

Review the returned selection, capacity, price and request. If the user approves it, rerun without --dry-run and add --yes plus an explicit timeout:

In JSON mode, creation cannot open the interactive wizard. Supply --gpu, --count, --cpu, --memory, --image, --region and --zone. Here --count is GPUs per instance; --max-count is the number of instances.

Inspect and manage instances

Use the direct instance ID commands without guessing a Region or Zone; the CLI resolves the location. Batch operations report succeeded and failed instances separately and exit nonzero on partial failure.

Other instance workflows are available under:

Inspect each workflow with compshare --json instance COMMAND --help before invoking it.

SSH and file transfer

Use instance ssh for an interactive shell or a short synchronous command:

Always place remote command arguments after -- so the CLI does not parse them as local options. Use sh -lc only when the remote command needs shell syntax such as pipes, redirects, && or variable expansion.

Copy a file or directory by prefixing the remote path with ::

The CLI automatically resolves and caches SSH connection data. Use --refresh after a password reset or reinstall, and --no-cache when cached connection data must not be used.

Durable remote jobs

Use instance job for installation, training, compilation and other work that must survive a local terminal or network disconnect:

Use --follow for live logs. For incremental agent reads, use byte offsets from the previous JSON response:

Cancel or prune jobs only when authorized:

A job wait timeout does not cancel the remote job. Query its state before submitting replacement work.

Dedicated bandwidth

List dedicated bandwidth resources and inspect instance EIP assignments:

Purchase, resize or delete only after reviewing the corresponding dry run. Prices are returned in cents by the API, while human output renders CNY:

Switch one or more instance EIPs without supplying locations; the CLI resolves and groups them by availability zone:

Dedicated bandwidth is available only in supported UCloud availability zones. Each account can purchase at most one per zone. Existing instances do not switch automatically after purchase; new instances in that zone use it by default. Deleting migrates bound EIPs back to shared bandwidth before releasing the resource.

Images, storage and teams

Discover subcommands first, then inspect the exact operation:

Common entry points:

Treat image deletion, disk deletion, disk detach/resize, quota changes and team mutations as state-changing operations. Read the current resource and request confirmation before adding --yes where supported.

MiniMax H3 media tasks

Inspect points and existing work before creating a task:

Preview the request, then create only after approval. Reuse an explicit idempotency key when retrying an uncertain request:

Use --first-frame and --last-frame for frame-driven video, or repeat --reference-image, --reference-video and --reference-audio for reference-driven video. Video supports 480P, 768P, 1080P, 2K and 4K and durations from 4 to 30 seconds. Use minimax skill list to find a Skill, then pass both --context-ir and --skill-id. Video inputs may use publicly accessible URLs or Data URLs. For callbacks, pass --callback-url and set COMPSHARE_MINIMAX_CALLBACK_TOKEN if the receiver validates a token. Generated video URLs stay redacted unless the user explicitly needs them and --show-sensitive is added as a root option.

Cancellation reads the current task before submitting the request:

For images, inspect current pricing before creating a task. Each request creates one image:

For reference images, minimax image upload FILE --width PIXELS --height PIXELS --yes returns an asset ID; repeat --reference-asset ASSET_ID when creating an image. Check the actual dimensions before upload because the API validates them.

For speech, inspect pricing and voices before creating a task:

For an authorized reference recording, minimax audio upload FILE --duration-ms MS --yes returns an asset ID. Use --voice-source asset --asset-id ASSET_ID, or save it with minimax audio voice-create ASSET_ID NAME --yes and then use --voice-source custom --voice-id VOICE_ID. Generated image and speech URLs stay redacted unless the user explicitly needs them and --show-sensitive is added as a root option. Download speech output promptly; the API retains it for seven days. Deleting a finished task also removes its output.

Diagnostics and feedback

Use doctor for local configuration, authentication, network and SSH environment checks. Use feedback only when the user asks to send feedback; it performs an external write.

JSON contract

Successful commands return one UTF-8 JSON document shaped like:

Failures return ok: false with a stable error.code, a human-readable error.message and optional error.details. List commands place rows in data.items and pagination or API metadata in meta. Check the process exit code as well as ok; batch operations can fail partially.

Troubleshooting

• Authentication or configuration failure: run compshare --json doctor, then inspect compshare config list without exposing credential values.
• No available specification: search again with the exact image and --available; relax GPU, Region, Zone, CPU, memory, billing or disk constraints deliberately.
• JSON creation asks for interaction: provide all seven required automation options listed in the create section.
• SSH option parsed by the CLI: insert -- before the remote command.
• Long SSH command interrupted: resubmit it as an instance job rather than retrying synchronously.
• Lifecycle or job timeout: inspect current state before retrying; do not assume the remote operation stopped.
• Unexpected option or output: query compshare --json COMMAND --help and follow the installed version rather than this reference.