Getting Started

Quickstart

Install the CLI, upload a document, and share it for review — all in under 2 minutes.

1

Install the CLI

Terminal
npm install -g @tailor-app/cli

Requires Node.js 20+. Verify the installation:

tailor --version
@tailor-app/cli v0.7.0
2

Authenticate

Option A — Environment Variable (agents & CI)

bash
export TAILOR_API_KEY=tailor_sk_YOUR_KEY
tailor list   # works immediately — no login needed

Recommended for AI agents and CI/CD. No interactive login required.

or

Option B — Store Key to Disk

bash
tailor login --key tailor_sk_abc123

Saves the key to your local config file. Good for personal machines.

or

Option C — Magic Link (humans)

bash
tailor login --email you@company.com

Opens your browser for one-click sign-in. Requires a terminal.

3

Upload a Document

Terminal
tailor upload ./my-document.docx
 Uploaded my-document.docx
  ID: doc_8f3a2b1c
  Size: 24.3 KB

Supports DOCX, PDF, MD, TXT, and HTML. You can also upload entire folders.

4

Share for Review

Terminal
tailor share doc_8f3a2b1c --permission FullReview
 Share link created
  URL: https://tailor.au/r/abc123
  Permission: FullReview
  Access: Open

Reviewers can comment, suggest changes, and approve — right in the browser. No account required for open links.

5

Check Status

Terminal
tailor status doc_8f3a2b1c
my-document.docx
  Status: In Review
  Reviewers: 2 invited, 1 completed
  Comments: 3 open, 1 resolved
  Changes: 5 tracked

Next Steps