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
  • Install on Mac
  • Install on Linux x86
  • Install on Windows (Beta)
  • Install on Linux ARM (Beta)
  • CLI Configuration
  1. Getting Started

Install CLI

Hyper currently provides official CLI builds for Linux and Mac.

  • Linux x86

  • Mac OS X 10.7 (lion) or later

  • Windows (Beta)

  • Linux ARM (Beta)

Please note The hyper client will attempt to update itself to the latest version once per day automatically. If you don't want to wait for the next daily cycle, just remove ~/.hyper/cktime.json, and the check will occur immediately.

Install on Mac

$ curl -O https://hyper-install.s3.amazonaws.com/hyper-mac.bin.zip
$ unzip hyper-mac.bin.zip 
$ ./hyper --help

or

$ brew install hyper

Install on Linux x86

$ wget https://hyper-install.s3.amazonaws.com/hyper-linux-x86_64.tar.gz
$ tar xzf hyper-linux-x86_64.tar.gz
$ ./hyper --help

Install on Windows (Beta)

  • Unzip this package

  • Open Windows Command Prompt and run .\hyper.exe --help

Install on Linux ARM (Beta)

$ wget https://hyper-install.s3.amazonaws.com/hyper-arm.tar.gz
$ tar xzf hyper-arm.tar.gz
$ ./hyper --help

CLI Configuration

Once the installation completes, enter hyper config in your terminal and the CLI will prompt you for your API credential:

The credential is stored in a local configuration file $HOME/.hyper/config.json. The configuration file is similar to Docker's, with an extra section clouds.

Or you can use environment vairables HYPER_ACCESS and HYPER_SECRET to pass the access key and secret key to the CLI which will search for these environment variables before loading the configuration file.

PreviousGenerate API CredentialNextPart 1 - Starting and inspecting your first container

Last updated 7 years ago

Download package from

Note: this package on Windows is beta version, please file a bug at if you find any issue.

https://hyper-install.s3.amazonaws.com/hyper-win64.zip
here