Docs · Install

Install via npm / pnpm

The full AT-1 (TinyFiles) command-line tool, installed from npm as a native prebuilt binary — no Python, no toolchain. Works with npm, pnpm, yarn, and bun.

Install

# global install (any one)
npm   install -g @tinyfiles/cli
pnpm  add     -g @tinyfiles/cli
yarn  global add @tinyfiles/cli

# then:
at1 --help

Use it

at1 compress qcolumnar trades.csv trades.at1     # verified-lossless, queryable
at1 sql        trades.at1 "SELECT aggId, price WHERE ts BETWEEN 1704067200000 AND 1704067210000"
at1 query      trades.at1 --where price:42000:43000 --select aggId,price
at1 info       trades.at1                          # codec, schema, is-queryable, integrity
at1 decompress trades.at1 trades.out               # byte-for-byte identical
at1 verify     trades.at1                          # re-check the SHA-256 trailer

Full command reference: CLI docs. Only qcolumnar (tables/CSV) and qjson (NDJSON) are queryable in place — see Getting started.

Project-local & one-off

# project-local (no global): add it as a dev dependency and run via your package runner
npm  i -D @tinyfiles/cli   &&  npx at1 compress qcolumnar data.csv data.at1
pnpm add -D @tinyfiles/cli  &&  pnpm exec at1 sql data.at1 "SELECT id WHERE ts BETWEEN 1 AND 9"

# one-off, no install:
npx  @tinyfiles/cli@latest --help
pnpm dlx @tinyfiles/cli --help

In CI

# CI / headless: set the key via env instead of `at1 login`
- run: npm i -g @tinyfiles/cli
  env:
    AT1_LICENSE_KEY: ${{ secrets.AT1_LICENSE_KEY }}
- run: at1 compress qcolumnar build/metrics.csv artifacts/metrics.at1

How the install works

@tinyfiles/cli is a tiny launcher that depends, via optionalDependencies, on per-platform packages (@tinyfiles/cli-win32-x64, @tinyfiles/cli-darwin-arm64, …). Each carries only the compiled binary and is tagged with os/cpu, so your package manager downloads only the one for your machine. There is no install script — which is exactly why it works under pnpm's default script-blocking (no pnpm approve-builds needed), and under yarn and bun too.

Accounts & metering

Same as the pip and desktop clients: decoding is always free and needs no account. Any encoding (creating archives) requires a free connected account and is metered against it — run at1 login or set AT1_LICENSE_KEY. The free tier covers a one-time 100 GB-compressed trial (free account, no card). See pricing.

Troubleshooting

• “no prebuilt binary for <platform>”. Supported targets are the four above. On anything else, grab the desktop app or build from source — see Download.
• pnpm didn't fetch the binary.It should — there's no build step to approve. If you've set optional=false in .npmrc, the platform package (an optional dependency) is skipped; remove that to allow it.
• Just need to decode in JS/the browser? Use @tinyfiles/decoder (decode + WASM query), no CLI required — see SDK.