Skip to content
← Documentation
On this page

Quick start

This gets you from nothing to a running app in two commands, on infrastructure you bring. If you would rather not bring any, Anyport can run the cluster for you: see If you want Anyport to run it.

Two commands. The cluster shows up in the console already connected, and no token is ever displayed, pasted, or left in your shell history.

What you need#

  • An Anyport account. You can create one during sign-in — the CLI opens it for you.
  • Either a Kubernetes cluster you can reach with kubectl, or a container runtime such as Docker, OrbStack, colima or Podman, or a plain Linux machine with root. If you have none of those, a cloud VM with 2 vCPU and 4 GB of RAM is enough to start, or Anyport Cloud needs nothing at all.

You do not need kubectl or Helm installed. The CLI talks to Kubernetes directly.

Step 1: Install the CLI#

curl -fsSL https://anyport.dev/cli.sh | sh

macOS and Linux. For Windows, download the anyport binary for your architecture and put it on your PATH.

To do both steps at once, add --init and the script runs anyport init for you when it finishes:

curl -fsSL https://anyport.dev/cli.sh | sh -s -- --init

Step 2: Run anyport init#

anyport init

It signs you in, asks how you want to run your apps, and connects a cluster. Safe to run again at any point — it picks up from whatever is already done.

There is no token to copy. The CLI creates the cluster's agent token and uses it in the same process, so it is never displayed, never pasted, and never left in your shell history.

If you already have a cluster#

anyport init installs the agent into whatever kubectl currently points at. To choose a different context, or to skip the questions:

anyport cluster attach --context my-cluster

If you want one on this machine#

Anyport builds a local Kubernetes cluster inside your container runtime. It is disposable — removing it takes everything in it.

anyport cluster create

Anyport never installs a container runtime for you. If none is running it tells you which to install and how.

If you want a server to be the cluster#

Run this on the server, as root. It installs k3s as a system service:

anyport cluster create --dedicated

Or set one up without leaving your own machine:

anyport cluster create --ssh root@your-server

Everything it installs is recorded, so anyport cluster detach <name> --purge removes exactly that and nothing else. Add --dry-run to see the list first.

If you want Anyport to run it#

Anyport Cloud runs the cluster on Anyport's hardware, so nothing is installed anywhere of yours. It is part of Pro ($5 a month, with $5 of credit back), and each cluster is $5 a month, billed by the hour. Choose Pro under Settings → Billing in the console, then:

anyport cluster create --cloud

Or choose Run it on Anyport Cloud when connecting a cluster in the console. See Anyport Cloud for what it costs and what works differently.

Step 3: Deploy something#

  1. Create a project. A project is an isolated space with its own apps, config and secrets, so dev and staging stay separate.
  2. Inside it, create an app. Point it at a GitHub repository and Anyport builds and rolls it out on every push, or give it a container image you already have.
  3. Open the app once it is running. It gets a URL immediately; attach your own domain whenever you like.

Step 4: See what it is doing#

Live logs and a current CPU/memory snapshot work straight away. For searchable log history and metrics over time, install the Observability service once per cluster from the services catalog; on Anyport Cloud both are already there. See Logs & metrics.

Signing in without a browser#

On a machine with no browser — an SSH session, a container — the loopback sign-in cannot work, because the browser has to reach a port on the same machine. Use a code instead:

anyport auth login --device

It prints a short code to approve from any other device.

Next steps#