[{"_1":2,"_3":-5,"_4":-5},"loaderData",{"_5":6,"_7":8,"_9":10,"_11":12},"actionData","errors","root",{"_164":-5,"_167":168,"_169":170},"routes/shell",{"_41":42,"_163":-5,"_164":-5,"_165":166},"routes/repo",{"_34":-7,"_35":36,"_37":38,"_39":40,"_41":42,"_43":32,"_44":32,"_45":32,"_46":32,"_47":32,"_48":32,"_49":50,"_51":52,"_53":32,"_54":-7,"_55":-7,"_56":57,"_58":59,"_60":61,"_62":-5,"_63":64,"_65":66,"_67":68,"_69":70},"routes/repo.blob",{"_13":14,"_15":16,"_17":18,"_19":20,"_21":22,"_23":24,"_25":-5,"_26":27,"_28":29,"_29":30,"_31":32,"_33":14},"ref","main","path","www/content/docs/install.md","oid","cfe9a85b0d86fabb74cd17a2d21aa189076a170e","size",4378,"commit","12e96b5435e408a25422fcfd87d6fa5474b6e53a","mounts",[],"source","plain",{"_13":14,"_15":16},"kind","text","---\ntitle: Install\nsummary: Install the tidy command, or the tidyrs package for the Node API, and check that it works.\ngroup: Usage\norder: 1\n---\n\n\n> **tidy has not had its first tagged release yet.** Until it does, build the\n> command from source with cargo. The install script and the prebuilt binaries\n> below describe how it will work, and will start answering the moment a release\n> is tagged.\n\n## From source\n\nBuilding needs a Rust toolchain. It takes a few minutes the first time.\n\n```sh\n$ cargo install --git https://github.com/lukeed/tidy tidy_cli\n```\n\nOr from a clone of the repository:\n\n```sh\n$ git clone https://github.com/lukeed/tidy\n$ cd tidy\n$ cargo install --path crates/tidy_cli\n```\n\nEither way the binary is called `tidy`, and lands in `~/.cargo/bin`.\n\n## npm\n\nThe `tidyrs` package is the [Node API](/docs/node/), not the command. It ships a native addon for your platform as an optional dependency, so nothing is compiled on install.\n\n```sh\n$ npm install --save-dev tidyrs\n```\n\n```js\nimport { format } from \"tidyrs\";\n\nformat(\"

\", { filepath: \"index.html\" });\n//=> \"

\\n\"\n```\n\nIt has no `bin`, so `npx tidy` does not work. Use the command from source, above.\n\n## Install script\n\n```sh\n$ curl -fsSL https://tidy.lukeed.com | sh\n```\n\nThe script detects your platform, downloads the matching archive from the latest GitHub release, checks its SHA-256, and installs it to `~/.local/bin`. The same URL in a browser shows the home page; `curl` gets the script, because the server answers on the user agent.\n\nRead it before you run it:\n\n```sh\n$ curl -fsSL https://tidy.lukeed.com/install.sh | less\n```\n\nTwo environment variables change what it does:\n\n| Variable | What it does |\n| -------------- | --------------------------------------------------------------------- |\n| `TIDY_VERSION` | Install a specific release, such as `v0.1.0`. Defaults to the latest. |\n| `TIDY_INSTALL` | Where the binary goes. Defaults to `~/.local/bin`. |\n\n```sh\n$ TIDY_INSTALL=/usr/local/bin curl -fsSL https://tidy.lukeed.com | sh\n```\n\n## Prebuilt binaries\n\nEach release on [GitHub](https://github.com/lukeed/tidy/releases) will carry an archive per platform, with a `.sha256` beside it:\n\n| Platform | Archive |\n| -------------------- | ---------------------------------------- |\n| macOS, Apple silicon | `tidy-aarch64-apple-darwin.tar.gz` |\n| macOS, Intel | `tidy-x86_64-apple-darwin.tar.gz` |\n| Linux, x86-64 | `tidy-x86_64-unknown-linux-musl.tar.gz` |\n| Linux, ARM64 | `tidy-aarch64-unknown-linux-musl.tar.gz` |\n| Windows, x86-64 | `tidy-x86_64-pc-windows-msvc.zip` |\n\nThe Linux builds link against musl, so they run on any distribution and inside a `scratch` container.\n\n## Verified installs\n\nEvery release carries `packslip.sigstore.json`, a [packslip](https://packslip.dev) manifest. It is signed by the release workflow's own identity, with no long-lived key, and it states each archive's digest, platform and the executables inside it.\n\nThat lets an installer verify what it downloads instead of trusting a file name or a checksum served beside the binary:\n\n```sh\n$ packslip install github.com/lukeed/tidy\n```\n\nmise reads the same manifest through its packslip backend:\n\n```sh\n$ mise use -g packslip:github.com/lukeed/tidy\n```\n\nTo check an archive you already have:\n\n```sh\n$ packslip verify github.com/lukeed/tidy\n```\n\n\n> The install script above checks the `.sha256` published beside each archive,\n> which catches a truncated download, not a hostile one — a POSIX shell cannot\n> verify a signature. Where it matters, install through packslip or mise, which\n> can.\n\n## Check it works\n\n```sh\n$ tidy --version\n$ echo '

' | tidy --stdin-filepath index.html\n```\n\nThe second command prints `

`. If the shell cannot find `tidy`, the install directory is not on your `PATH`:\n\n```sh\n$ export PATH=\"$HOME/.local/bin:$PATH\"\n```\n\nAdd that to your shell profile to make it stick. For a cargo install, the directory is `~/.cargo/bin`.\n\n## Next\n\n- [CLI](/docs/cli/) — every flag.\n- [Configuration file](/docs/configuration/) — `tidy.json`, and where it is looked for.\n- [CI](/docs/ci/) — failing a build on unformatted files.\n","editable",false,"branch","documentNavigation","repo","lukeed/tidy","repoId","b2cac5cc-818f-4958-803a-7d401ccd9a90","ownerId","user:5855893","site","nexthub","private","admin","settings","maintainer","triage","starred","stars",0,"watchers",1,"watching","pinned","notify","views",[119,120,121,122,123,124,125,126,127,128,129,130,131],"navigation",{"_56":57,"_78":79,"_80":81,"_82":83,"_84":85,"_86":87,"_88":89},"sources",[],"viewer","meta",{"_71":72,"_73":74,"_75":72,"_43":32,"_76":14,"_77":32,"_49":50,"_51":52},"branches",[14],"tags",[],"cloneUrl","https://git.nexthub.sh/lukeed/tidy.git","description","","owner","lukeed","section","head","empty","pins",[101,102,103],"documents",{"_98":99,"_100":50},"code",{"_95":96,"_97":50},"automations",{"_92":93,"_94":-5},"delivery",{"_90":50,"_91":-5},"tag","W1_y18R9FUcyveBRlHeRXdVTtjo","releases","applications","workflows",2,"deployments","commits",350,"changes","counts",{},"total",{"_104":97,"_106":117,"_15":97,"_108":118,"_54":110,"_111":32,"_112":110,"_113":50},{"_104":114,"_106":115,"_15":114,"_108":116,"_54":110,"_111":32,"_112":110,"_113":50},{"_104":105,"_106":107,"_15":105,"_108":109,"_54":110,"_111":32,"_112":110,"_113":50},"id","issues","name","Issues","filters",{},true,"saved","pinnable","count","tasks","Tasks",{},"Changes",{},{"_104":97,"_106":117,"_15":97,"_108":162,"_54":110,"_111":32,"_112":110},{"_104":114,"_106":115,"_15":114,"_108":161,"_54":110,"_111":32,"_112":110},{"_104":105,"_106":107,"_15":105,"_108":160,"_54":110,"_111":32,"_112":110},{"_104":157,"_106":158,"_15":157,"_108":159,"_54":32,"_111":32,"_112":110},{"_104":154,"_106":155,"_15":154,"_108":156,"_54":32,"_111":32,"_112":110},{"_104":92,"_106":152,"_15":84,"_108":153,"_54":32,"_111":32,"_112":110},{"_104":94,"_106":149,"_15":150,"_108":151,"_54":32,"_111":32,"_112":110},{"_104":90,"_106":147,"_15":90,"_108":148,"_54":32,"_111":32,"_112":110},{"_104":143,"_106":144,"_15":145,"_108":146,"_54":32,"_111":32,"_112":110},{"_104":80,"_106":141,"_15":80,"_108":142,"_54":32,"_111":32,"_112":32},{"_104":138,"_106":139,"_15":138,"_108":140,"_54":32,"_111":32,"_112":32},{"_104":135,"_106":136,"_15":135,"_108":137,"_54":32,"_111":32,"_112":32},{"_104":132,"_106":133,"_15":132,"_108":134,"_54":32,"_111":32,"_112":32},"decisions","Decisions",{},"changelog","Changelog",{},"roadmap","Roadmap",{},"Documents",{},"activity","Activity","insights",{},"Releases",{},"Deployments","automations/deployments",{},"Workflows",{},"discussions","Discussions",{},"goals","Goals",{},{},{},{},"groups","user","agents",[],"now",1794535830818,"sidebar","expanded"]