Installation

There are three ways to work with an oikapi instance, and all three reach the same API:

• The web interface — administering an instance and working with records. Nothing to install.
• The oi CLI — scripting, CI, and app development. This page covers installing it.
• The REST API — anything you drive from your own code. See the API reference.

Use whichever fits the task. Most day-to-day administration happens in the web interface; the CLI is what you reach for when a change should be repeatable, reviewable, or scripted.

Note

oikapi is a managed platform — we deploy and operate the server for you. The instructions below cover only installing the CLI on your local machine. Your instance URL is provided when your environment is provisioned. If you are running a self-hosted deployment, see the self-hosted operations guide for server installation.

Install the CLI

On macOS and Linux:

curl -fsSL https://get.oikapi.com/cli | sh

The installer detects your operating system and architecture — there is nothing to choose between Apple Silicon, Intel, and x86_64 Linux.

On Windows, use PowerShell:

irm https://get.oikapi.com/cli.ps1 | iex

Connect to your instance

# Log in to your oikapi instance
oi login https://your-instance.example.com

# Verify your connection
oi whoami

Tip

Your credentials are saved securely in your system keychain, so you only need to log in once. Run oi logout to clear them.

Verify the installation

# Check version
oi version

# List available tables
oi table list

Next steps

• Quick Start – Create your first table
• CLI Reference – Full command reference
• App Development – Build custom applications