Quickstart

Install the CLI

curl -fsSL https://install.loonfs.com | sh
loonfs version

Connect to LoonFS

The CLI can connect to a LoonFS server or directly to an object storage bucket. Choose one of the following:

Option A: Connect to a server

Use the server’s HTTPS endpoint and bearer token:

export LOONFS_AUTH_TOKEN="<your-token>"

loonfs --no-input profile create remote default \
  --server-url "https://<your-endpoint>"

Option B: Connect directly to S3

In embedded mode, the CLI reads and writes directly to the bucket. No LoonFS server is required.

First, follow the S3 configuration guide to create a bucket and configure credentials. Then create a profile:

loonfs --no-input profile create s3 default \
  --bucket "<bucket_name>" \
  --region "<aws_region>"

Create a namespace

A namespace contains the files and folders for the filesystem.

loonfs namespace create demo
loonfs use demo

Write and read a file

printf 'Hello from LoonFS\n' | loonfs put - /hello.txt
loonfs ls /
loonfs cat /hello.txt

The final command prints Hello from LoonFS.

See the CLI reference for more commands, including copying files, viewing revision history, and restoring deleted files.

Finally, a hosted LoonFS server can be used without the CLI via the API or any of the available SDKs.