Hyper Docs
  • Introduction
  • What is Hyper
  • Why Hyper
  • Regions
  • Pricing
  • Quota and Limits
  • FAQ
  • Getting Started
    • Generate API Credential
    • Install CLI
    • Part 1 - Starting and inspecting your first container
    • Part 2 - Working with multiple containers
    • Part 3 - Hyper Compose
    • Migrate data
      • hyper container as client
      • hyper container as server
  • Features
    • Container
      • Container
      • Logs
      • Compose
      • Cron
      • Service
      • Func
    • Storage
      • Volume
      • Snapshot
    • Network
      • Network
      • Floating IP
      • Port
      • Security Group
    • Console
      • Filter
  • Reference
    • CLI
      • attach
      • commit
      • config
      • create
      • exec
      • images
      • info
      • inspect
      • kill
      • load
      • login
      • logout
      • logs
      • port
      • ps
      • pull
      • push
      • rename
      • restart
      • rm
      • rmi
      • run
      • search
      • start
      • stats
      • stop
      • version
      • update
      • wait
      • Volume
        • create
        • init
        • inspect
        • ls
        • rm
      • Snapshot
        • create
        • ls
        • rm
      • FIP
        • allocate
        • attach
        • detach
        • ls
        • release
        • name
      • Security Group
        • create
        • ls
        • inspect
        • rm
        • update
      • Compose
        • create
        • down
        • up
        • rm
        • ps
        • pull
        • run
        • kill
        • start
        • stop
        • scale
      • Service
        • create
        • ls
        • inspect
        • scale
        • rolling-update
        • attach-fip
        • detach-fip
        • rm
      • Cron
        • create
        • inspect
        • ls
        • history
        • rm
      • Func
        • create
        • update
        • inspect
        • ls
        • rm
        • logs
        • call
        • get
    • API
      • 2016-04-04 [Ver. 1.23]
        • Container
          • List Containers
          • Create a container
          • Get container logs
          • Start a container
          • Stop a container
          • Restart a container
          • Resize a container
          • Rename a container
          • Kill a container
          • Attach to a container
          • Remove a container
          • Update a container
          • Get container stats
          • Inspect a container
          • Exec Create
          • Commit a container
        • Event
          • Monitor events with WebSocket
        • Misc
          • Display system-wide information
          • Show the hyper version information
          • Exec Start
          • Exec Resize
          • Exec Inspect
        • Image
          • Inspect Images
          • Search Images
          • List Images
          • Load Images
          • Create an image
          • Remove an image
          • Push an image
        • Volume
          • List volumes
          • Create a volume
          • Remove a volume
          • Init a volume
          • Inspect a volume
        • Snapshot
          • Create a snapshot
          • List snapshots
          • Inspect a snapshot
          • Remove a snapshot
        • Network
          • Allocate floating IP
          • Attach a floating IP to a (running) container
          • Detach floating IP from a (running) container
          • List floating IP
          • Release floating IP
          • Name floating IP
        • Security Group
          • Create a security group
          • Remove a security group
          • Inspect a security group
          • Update a security group
          • List security groups
        • Service
          • service create
          • service list
          • service inspect
          • service update
          • service remove
        • Compose
          • Compose up
          • Compose create
          • Compose down
          • Compose rm
          • Compose start
          • Compose stop
          • Compose kill
        • Cron
          • Cron create
          • Cron list
          • Cron inspect
          • Cron remove
          • Cron history
        • Func
          • Func create
          • Func update
          • Func list
          • Func inspect
          • Func remove
          • Func call
          • Func get
          • Func logs
          • Func status
    • Compose File Reference
    • Security Group Reference
  • FAQ
    • Pricing
    • Quota and Limits
    • Privacy Policy
    • Terms of Service
    • Acceptable Use Policy
  • Docs version
Powered by GitBook
On this page
  1. Reference

CLI

Usage: hyper [OPTIONS] COMMAND [arg...]
       hyper [ --help | -v | --version ]

A self-sufficient runtime for containers.

Options:

  --config=~/.hyper       Location of client config files
  -D, --debug             Enable debug mode
  -h, --help              Print usage
  -l, --log-level=info    Set the logging level
  -R, --region            Set the region of hyper.sh
  -v, --version           Print version information and quit

Commands:
    attach    Attach to a running container
    commit    Create a new image from a container's changes
    compose   Define and run multi-container applications with Hyper
    config    Config access key and secret key to Hyper server
    create    Create a new container
    cron      Manage cron service of Hyper
    exec      Run a command in a running container
    fip       Manage Hyper floating IPs
    func      Manage func service of Hyper
    history   Show the history of an image
    images    List images
    info      Display system-wide information
    inspect   Return low-level information on a container or image
    kill      Kill a running container
    load      Load a local image or a tar file
    login     Register or log in to a Docker registry
    logout    Log out from a Docker registry
    logs      Fetch the logs of a container
    port      List port mappings or a specific mapping for the CONTAINER
    ps        List containers
    pull      Pull an image or a repository from a registry
    push      Push an image or a repository to a registry
    rename    Rename a container
    restart   Restart a container
    rm        Remove one or more containers
    rmi       Remove one or more images
    run       Run a command in a new container
    search    Search the Docker Hub for images
    service   Manage service of Hyper
    sg        Manage security group of Hyper
    snapshot  Manage Hyper snapshots
    start     Start one or more stopped containers
    stats     Display a live stream of container(s) resource usage statistics
    stop      Stop a running container
    update    Update resources of one or more containers
    version   Show the Hyper version information
    volume    Manage Hyper volumes
    wait      Block until a container stops, then print its exit code

Run 'hyper COMMAND --help' for more information on a command.
  • Los Angeles: us-west-1

  • Frankfurt: eu-central-1

You may specify the region via the --region option when you want to manage the resources located in that specific region. The Los Angeles region will be the default region.

NOTE: Options with the IGNORED mark are not supported currently and will be ignored.

PreviousReferenceNextattach

Last updated 7 years ago

Now, we have support for two

regions
attach
commit
create
exec
images
info
inspect
kill
load
login
logout
logs
port
ps
pull
push
rename
restart
rm
rmi
run
start
stats
stop
update
version
search
volume
create
ls
rm
snapshot
create
ls
rm
fip
allocate
attach
detach
ls
release
name
sg (security group)
create
ls
inspect
rm
update
compose
create
down
up
rm
ps
run
kill
start
stop
scale
service
create
ls
inspect
scale
rolling-update
attach-fip
detach-fip
rm
func
create
update
ls
inspect
rm
call
logs
get