Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/mikronita/mikrom/llms.txt

Use this file to discover all available pages before exploring further.

Mikrom is a multi-tenant platform where resources — applications, databases, volumes, and access tokens — are scoped to a project. Every project has a unique six-character tenant ID slug (e.g. abc123) that identifies it across the platform. The mikrom project commands let you list the projects your account has access to, create new projects, and switch the active project context so that subsequent CLI commands operate against the correct tenant.

​
Understanding Projects

When you authenticate with mikrom auth login, your session is associated with one active project at a time. That active project context is stored in the CLI configuration and is used as the default tenant for every command you run — from deploying apps to creating databases. You can switch the active project at any time without re-authenticating.
The tenant-id used by mikrom project switch is a 6-character slug (letters and digits), not a full UUID. You can find your project’s tenant ID in mikrom project list output.

​
mikrom project list

List all projects your account has access to, including their names and tenant ID slugs. 
mikrom project list
Example output 
TENANT ID   NAME
abc123      personal
def456      acme-corp

​
mikrom project create

Create a new project under your account. After creation, use mikrom project switch to activate it as your working context. 
mikrom project create --name <name>
​
--name / -n
string
required
Display name for the new project (e.g. acme-production).
Example 
mikrom project create --name acme-production
Example output 
Project created.
  Name:      acme-production
  Tenant ID: ghi789

​
mikrom project switch

Switch the active CLI context to a different project. After switching, all subsequent commands will target that project until you switch again. 
mikrom project switch <tenant-id>
​
tenant-id
string
required
The 6-character slug of the project to activate (visible in mikrom project list).
Example 
mikrom project switch def456

​
Equivalent: mikrom config set

You can achieve the same context switch using mikrom config set directly, which writes the active-project key to the CLI configuration file: 
mikrom config set active-project def456
Both commands are equivalent — mikrom project switch is a convenience wrapper around the config setter. Use whichever fits your workflow. 
# Switch to the acme-corp project
mikrom project switch def456

# Verify the active project
mikrom config show

​
Typical Workflow

1

List your projects

mikrom project list
Note the tenant ID of the project you want to work in.
2

Switch context

mikrom project switch def456
Your CLI is now scoped to the acme-corp project.
3

Verify the active context

mikrom config show
Confirm that active-project shows the expected tenant ID.
4

Deploy or manage resources

mikrom app list
mikrom db list
All commands now operate within the acme-corp project.

Build docs developers (and LLMs) love

Get started for freeTalk to us