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.
Install the CLI
On macOS and Linux:
macOS and Linuxcurl -fsSL https://get.rykloud.com/install.sh | shOn Windows, in PowerShell:
Windows PowerShellirm https://get.rykloud.com/install.ps1 | iexBoth 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 versionSign in with your Rykon account
rykloud auth login # opens your browser rykloud auth login --device # no browser here: enter a code on another deviceThe CLI keeps the session in your system keychain and never prints it.
--scope readmakes a session that can look at everything you may see and change nothing. Authentication explains sessions and tokens.Choose your organisation
rykloud orgs list rykloud contexts create acme --org "Acme Ltd" --useA context remembers the organisation (and, if you like, the project and environment) so you do not repeat
--orgon every command. No organisation yet?rykloud orgs create "Acme Ltd"makes one with you as its owner.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 8hRykloud 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, andrykloud envs approve stagingis theirs to run. Then follow it:rykloud envs watch stagingBefore 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 withpayment_required, and nothing is charged.- GET
/v1/organisations/{id}/environments/optionsWhat this organisation may ask for, with prices - POST
/v1/organisations/{id}/environmentsAsk for an environment: it is planned and priced, then waits for an owner - GET
/v1/organisations/{id}/environments/{envId}An environment, its plan, timeline and activity - POST
/v1/organisations/{id}/environments/{envId}/approveApprove the plan at its stated price (owner)
- GET
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_IDThe change is previewed with its price and applied when you confirm (
-yapplies 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 --followA 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.- POST
/v1/organisations/{id}/environments/{envId}/changes/previewPreview a resource change with its price - POST
/v1/organisations/{id}/environments/{envId}/changes/{cid}/applyApply a previewed change at its stated price - POST
/v1/organisations/{id}/environments/{envId}/resources/{rid}/buildsBuild a service from its branch head or a commit - GET
/v1/organisations/{id}/environments/{envId}/resources/{rid}/builds/{bid}/logsA build's log lines after a sequence number
- POST
Read the logs
rykloud services logs api --env staging --follow rykloud envs logs staging --since 30m --level errorStop 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 wasThe time limit you set with
--ttlstops 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.