Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.archil.com/llms.txt

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

This quickstart creates an Archil disk backed by an S3 bucket and runs a bash command against it from your terminal — no server, no mount, no install beyond npx.
If you already have a server that you want to attach Archil to, see Mount on Linux (FUSE) (or macOS / in a container).
1

Get an API key

Sign in to console.archil.com, create an API key from the API keys page, and export it:
export ARCHIL_API_KEY=key-...
export ARCHIL_REGION=aws-us-east-1
Pick the region closest to your S3 bucket.
2

Create a disk

Point a disk at an S3 bucket you own. Archil reads and writes directly to the bucket — nothing is moved or copied.
npx disk create my-disk
The output includes the disk’s ID (dsk-...) and a one-time disk token. The disk token is for mounting the disk later — you can ignore it for this quickstart, but save it if you plan to come back and mount.
If you already have an S3 or GCS bucket that you want to synchronize Archil data from, see how to create a file system in S3 Object Storage.
3

Run a commands like an agent

disk exec runs a bash command in a container with the file system already mounted, and returns stdout, stderr, and the exit code:
npx disk my-disk exec "ls -la"
Try something more interesting — grep across every file in the bucket, or pipe a result into wc -l:
npx disk my-disk exec "grep -r ERROR . | head"
npx disk my-disk exec "find . -name '*.json' | wc -l"
No data is copied to your laptop. Only the result comes back. Billing is the wall-clock time the command runs (1ms increments, 100ms minimum). See Serverless Execution for the full model and the disk CLI reference for every command and flag.
4

Or do it from code

The same flow from TypeScript:
import * as archil from "disk";

const { disk } = await archil.createDisk({
  name: "my-disk",
});

const { stdout } = await disk.exec("ls -la");
console.log(stdout);
See the TypeScript SDK reference for the full API.

​
Next steps

Mount to Linux Server

Run on Lambda or a Worker

Use disk.exec from AWS Lambda or Cloudflare Workers without provisioning compute.

Build a bash tool for an agent

Wire disk.exec into an AI agent loop — about 30 lines.

Pricing

View Archil pricing and plan details.