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.

The mikrom auth command group handles everything related to your Mikrom account — from initial registration and daily login, to inspecting your current session and keeping your profile up to date. After a successful login the CLI writes your session token to ~/.config/mikrom/ and automatically attaches it to every subsequent request.

​
mikrom auth login

Authenticates with the Mikrom API using your email and password, then stores the returned session token in the CLI config file so all future commands are automatically authorised. 
mikrom auth login --email <email> --password <password>
Example 
mikrom auth login --email alice@example.com --password s3cr3t!
Flags
​
--email
string
required
The email address associated with your Mikrom account.
​
--password
string
required
Your account password. Consider wrapping the value in single quotes if it contains special shell characters.
The session token is written to ~/.config/mikrom/ and reused by every subsequent CLI command. Run mikrom auth whoami to confirm the stored session is valid.

​
mikrom auth register

Creates a new Mikrom account with the provided email address and password. 
mikrom auth register --email <email> --password <password>
Example 
mikrom auth register --email alice@example.com --password s3cr3t!
Flags
​
--email
string
required
The email address you want to register. Must be unique across all Mikrom accounts.
​
--password
string
required
The password for your new account.
After registration completes you can immediately log in with mikrom auth login using the same credentials.

​
mikrom auth whoami

Displays the profile of the currently authenticated user by reading the session token stored in the CLI config file and querying the Mikrom API. 
mikrom auth whoami
Example 
mikrom auth whoami
Example output 
Email:      alice@example.com
First name: Alice
Last name:  Smith
If no valid session token is found, the command returns an authentication error. Run mikrom auth login first.

​
mikrom auth update

Updates one or both display-name fields on your Mikrom account. All flags are optional — supply only the fields you want to change. 
mikrom auth update [--first-name <name>] [--last-name <name>]
Example — update both names 
mikrom auth update --first-name Alice --last-name Smith
Example — update first name only 
mikrom auth update --first-name Alice
Flags
​
--first-name
string
New first name to set on your account. Omit this flag to leave the current value unchanged.
​
--last-name
string
New last name to set on your account. Omit this flag to leave the current value unchanged.

Build docs developers (and LLMs) love

Get started for freeTalk to us