Skip to main content
The TinyCloud CLI (tc) brings self-sovereign storage to your terminal. Manage key-value data, spaces, delegations, secrets, and more — all from the command line.

​
Installation

Install the CLI globally from npm: 
npm install -g @tinycloud/cli
Requires Node.js 18 or later.
Verify the installation: 
tc --version

​
Quick Start

Get up and running in under a minute:
1

Initialize a profile

Generate a new key pair and create your default profile.
tc init --name my-project
2

Sign in

Authenticate with a TinyCloud node to establish a session.
tc auth login
3

Store data

Write a value to key-value storage.
tc kv put greeting "Hello from the CLI"
4

Retrieve data

Read it back.
tc kv get greeting

Hello from the CLI
5

Explore your space

List your spaces and see what you have.
tc space list

​
Global Options

Every tc command accepts these flags:
OptionDescriptionDefault
--profile <name>Use a specific profiledefault
--host <url>Override the TinyCloud node URLProfile default
--verboseEnable verbose loggingfalse
--no-cacheDisable response cachingfalse
--quietSuppress non-essential outputfalse
--jsonForce JSON outputfalse
# Use a staging profile with verbose output
tc kv list --profile staging --verbose

# Force JSON output for scripting
tc auth status --json

​
Output Modes

The CLI automatically adjusts its output format based on context:
When running in a terminal, output is human-friendly with colors and formatting.
$ tc auth status
  Profile:  default
  Address:  0x1234...abcd
  Space:    0x1234...abcd-1-my-app
  Session:  Active (expires in 23h 42m)

​
Environment Variables

Configure default behavior with environment variables. These are overridden by command-line flags.
VariableDescriptionExample
TC_PROFILEDefault profile nameproduction
TC_HOSTDefault TinyCloud node URLhttps://node.tinycloud.xyz
TC_HIDE_BANNERSuppress the startup banner1
TC_PRIVATE_KEYPrivate key for automated workflows0xabc...
# Example: CI/CD environment
export TC_PROFILE=ci
export TC_HOST=https://node.tinycloud.xyz
export TC_PRIVATE_KEY=$SECRET_KEY
export TC_HIDE_BANNER=1

tc kv put deploy/version "1.2.3"
Never commit TC_PRIVATE_KEY to source control. Use your CI/CD provider’s secret management to inject it at runtime.

​
Command Groups

Authentication

Sign in, manage sessions, and check identity

Key-Value Storage

Store, retrieve, and manage data

Spaces

Create and manage data ownership containers

Delegations & Sharing

Grant access and share data with other users

Secrets & Variables

Manage encrypted secrets and plaintext variables

Profiles

Manage multiple environments and configurations

Diagnostics

Troubleshoot your setup with built-in checks

​
Source Code

The CLI is open source. Contributions and issues are welcome.

GitHub Repository

@tinycloud/cli on GitHub