Skip to content

docs(readme): follow fx layout with features, quick start and a commands table - #238

Merged
duyetbot merged 2 commits into
mainfrom
docs/readme-fx-style
Oct 28, 2026
Merged

duyetbot merged 2 commits into
mainfrom
docs/readme-fx-style

Conversation

@duyetbot

Copy link
Copy Markdown
Member

Owner request 2026-10-29: make the anyr README follow Vercel's fx (https://github.com/vercel-labs/fx).

What changes

Only README.md. The reference sections below ## Command reference (api, publish, artifact, keys, logs, pool, presets, mcp, relay, byok, Launchers, and so on) are untouched.

New top, in fx's order: hero line, install one-liner, a plain paragraph on what anyr is, ## Features (bold lead word, one claim each), a shorter ## Install, ## Quick start (sign in, launch an agent, one-shot chat with --json), a ## Commands table grouped like anyr help --all, then ## For agents and scripts. New tail: ## Documentation, ## Feedback, ## Contributing (cargo commands from AGENTS.md; Version lock and Git hooks moved under it).

Before (headings): Install, Upgrade, Quick start, then 20 ### reference sections.
After (headings): Features, Install, Quick start, Commands, For agents and scripts, Command reference, Launchers, Passing flags, Launcher settings, Documentation, Feedback, Contributing, License.

Checked against the shipped CLI

Built from this branch's base (origin/main at 0.1.36). Group names in the Commands table come from anyr help --all; launcher count (12) from the Launchers table; anyr login --device, --ok, update.auto/update.channel, ANYR_QUIET, NO_COLOR from anyr login --help, anyr claude --help, anyr config --help and anyr help agents. No command or flag was removed from the README. cargo test --test release_lock passes.

Dropped on purpose: the CI/coverage sentence in Install and the duplicate beta/stable install snippets under Upgrade (the same commands remain under Install).

🤖 Generated with Claude Code

duyet and others added 2 commits October 29, 2026 00:27
…nds table

Co-authored-by: Duyet Le <me@duyet.net>
Co-authored-by: duyetbot <bot@duyet.net>
Co-authored-by: Duyet Le <me@duyet.net>
Co-authored-by: duyetbot <bot@duyet.net>
@github-actions

github-actions Bot commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

anyr size and startup

Startup is wall time for a cold anyr --version / anyr --help (median of 21 runs). Size is the stripped release binary, or the .wasm for the browser demo.

Size budget: anyr-linux-x86_64 must stay ≤ 4.0 MiB (4194304 bytes) stripped.

Asset Kind Size --version median --help median
anyr-darwin-arm64 native 2.4 MiB 2.95 ms 2.58 ms
anyr-darwin-x86_64 native 2.9 MiB 27.31 ms 28.57 ms
anyr-linux-arm64 native 2.9 MiB 0.87 ms 0.94 ms
anyr-linux-x86_64 native 3.4 MiB 0.84 ms 0.88 ms
anyr-windows-x86_64.exe native 2.9 MiB 8.72 ms 8.68 ms
anyr.wasm wasm 252.0 KiB — —

Budget check: ok

raw timings
[
  {
    "asset": "anyr-darwin-arm64",
    "kind": "native",
    "path": "/Users/runner/work/cli/cli/anyr-darwin-arm64",
    "bytes": 2537288,
    "size": "2.4 MiB",
    "version": "0.1.36 (built 2026-10-28 17:45:46)",
    "target": "aarch64-apple-darwin",
    "os": "macos-latest",
    "startup_version": {
      "n": 21,
      "min_ms": 2.7,
      "median_ms": 2.95,
      "p95_ms": 3.49,
      "mean_ms": 3.03
    },
    "startup_help": {
      "n": 21,
      "min_ms": 2.45,
      "median_ms": 2.58,
      "p95_ms": 2.98,
      "mean_ms": 2.66
    }
  },
  {
    "asset": "anyr-darwin-x86_64",
    "kind": "native",
    "path": "/Users/runner/work/cli/cli/anyr-darwin-x86_64",
    "bytes": 3037656,
    "size": "2.9 MiB",
    "version": "0.1.36 (built 2026-10-28 17:35:46)",
    "target": "x86_64-apple-darwin",
    "os": "macos-latest",
    "startup_version": {
      "n": 21,
      "min_ms": 26.08,
      "median_ms": 27.31,
      "p95_ms": 39.13,
      "mean_ms": 29.99
    },
    "startup_help": {
      "n": 21,
      "min_ms": 26.07,
      "median_ms": 28.57,
      "p95_ms": 36.43,
      "mean_ms": 29.8
    }
  },
  {
    "asset": "anyr-linux-arm64",
    "kind": "native",
    "path": "/home/runner/work/cli/cli/anyr-linux-arm64",
    "bytes": 3020048,
    "size": "2.9 MiB",
    "version": "0.1.36 (built 2026-10-28 17:35:50)",
    "target": "aarch64-unknown-linux-gnu",
    "os": "ubuntu-24.04-arm",
    "startup_version": {
      "n": 21,
      "min_ms": 0.83,
      "median_ms": 0.87,
      "p95_ms": 0.95,
      "mean_ms": 0.88
    },
    "startup_help": {
      "n": 21,
      "min_ms": 0.86,
      "median_ms": 0.94,
      "p95_ms": 1.0,
      "mean_ms": 0.94
    }
  },
  {
    "asset": "anyr-linux-x86_64",
    "kind": "native",
    "path": "/home/runner/work/cli/cli/anyr-linux-x86_64",
    "bytes": 3521032,
    "size": "3.4 MiB",
    "version": "0.1.36 (built 2026-10-28 17:35:32)",
    "target": "x86_64-unknown-linux-gnu",
    "os": "ubuntu-latest",
    "startup_version": {
      "n": 21,
      "min_ms": 0.82,
      "median_ms": 0.84,
      "p95_ms": 0.88,
      "mean_ms": 0.85
    },
    "startup_help": {
      "n": 21,
      "min_ms": 0.83,
      "median_ms": 0.88,
      "p95_ms": 0.92,
      "mean_ms": 0.87
    }
  },
  {
    "asset": "anyr-windows-x86_64.exe",
    "kind": "native",
    "path": "D:\\a\\cli\\cli\\anyr-windows-x86_64.exe",
    "bytes": 2994688,
    "size": "2.9 MiB",
    "version": "0.1.36 (built 2026-10-28T17:36:37Z)",
    "target": "x86_64-pc-windows-msvc",
    "os": "windows-latest",
    "startup_version": {
      "n": 21,
      "min_ms": 8.59,
      "median_ms": 8.72,
      "p95_ms": 8.89,
      "mean_ms": 8.75
    },
    "startup_help": {
      "n": 21,
      "min_ms": 8.45,
      "median_ms": 8.68,
      "p95_ms": 8.87,
      "mean_ms": 8.68
    }
  },
  {
    "asset": "anyr.wasm",
    "kind": "wasm",
    "path": "/home/runner/work/cli/cli/target/wasm-pkg/anyr_cli_bg.wasm",
    "bytes": 258065,
    "size": "252.0 KiB",
    "version": "wasm",
    "target": "wasm32-unknown-unknown",
    "os": ""
  }
]

@duyetbot
duyetbot merged commit c8a5e0b into main Oct 28, 2026
10 checks passed
@duyetbot
duyetbot deleted the docs/readme-fx-style branch October 28, 2026 17:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants