Skip to the page

Get started

Quickstart

From nothing to a service running from your Git repository in an environment you approved, in seven steps. Every command here is one or two API operations, listed under each step.

  1. Install the CLI

    On macOS and Linux:

    macOS and Linux
    curl -fsSL https://get.rykloud.com/install.sh | sh

    On Windows, in PowerShell:

    Windows PowerShell
    irm https://get.rykloud.com/install.ps1 | iex

    Both scripts refuse to install unless the release's signature and checksum verify. To check a download by hand, see Install the CLI in the help centre. Then:

    rykloud version
  2. Sign in with your Rykon account

    rykloud auth login            # opens your browser
    rykloud auth login --device   # no browser here: enter a code on another device

    The CLI keeps the session in your system keychain and never prints it. --scope read makes a session that can look at everything you may see and change nothing. Authentication explains sessions and tokens.

  3. Choose your organisation

    rykloud orgs list
    rykloud contexts create acme --org "Acme Ltd" --use

    A context remembers the organisation (and, if you like, the project and environment) so you do not repeat --org on every command. No organisation yet? rykloud orgs create "Acme Ltd" makes one with you as its owner.

  4. Ask for an environment

    rykloud envs options     # sizes, places and products, each with its price
    rykloud envs create staging --cloud any --area eu --size general-s --stage staging --ttl 8h

    Rykloud plans the environment at the cloud and prices it. Nothing starts and nothing is charged until an owner of the organisation approves that exact price. If you are an owner, the CLI asks you once the plan is ready (or pass --approve); otherwise it waits for an owner, and rykloud envs approve staging is theirs to run. Then follow it:

    rykloud envs watch staging

    Before the first start

    An organisation starts billable environments once it has a payment method or prepaid credit in Billing in the console. Without one the approval is refused with payment_required, and nothing is charged.
  5. Deploy a service from Git

    Connect your Git host once, in the console: the organisation's Git tab (registering a host and signing in to it happen in the browser). Each connection has an id; then add a service built from a repository:

    rykloud resources add service api --env staging \
      --repo acme/api --branch main --connection $CONNECTION_ID

    The change is previewed with its price and applied when you confirm (-y applies at the price shown without asking). Every push to the branch builds and deploys unless you pass --auto-deploy=false. To build now and watch it:

    rykloud services deploy api --env staging --follow

    A service can also run an image (--image ghcr.io/acme/web:1.4.2), and the same command adds Postgres, Redis, buckets, secret groups and domains. See rykloud resources add.

  6. Read the logs

  7. Stop it when you are done

    rykloud envs stop staging      # keeps its data; nothing runs or bills at the cloud
    rykloud envs restore staging   # brings it back as it was

    The time limit you set with --ttl stops and keeps it on its own.

Next

  • Concepts: how environments, changes and approvals fit together.
  • CLI reference: output formats, exit codes, contexts and every command.
  • API reference: the same operations from your own code.