agentleFS
Sign inStart free
Hugging FaceKnown publisherhuggingface/xet-core/wasm/AGENTS.md

xet-core / wasm

AGENTS.md625 starsChanged 15 days agoApache-2.0View on GitHub

WebAssembly builds of xet-core. Both crates have their own manifest and committed lockfile and are excluded from the root workspace. Shared conventions are in the root guide. Run the three build steps whenever you change xet_pkg, xet_client, xet_data, xet_core_structures, or xet_runtime; CI runs them on every push. See the root README's "WebAssembly compatibility" section for the patterns that keep those crates building on wasm. The smoke scenarios talk to the production Hub and CAS. Read scenarios work anonymously; upload scenarios…

  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 31,542 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository3 other files it gives its agents.

The file

We split this AGENTS.md into the rules it gives an agent

2 rules. About 0 are common, 0 are distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Run the three build steps whenever you change xet_pkg, xet_client, xet_data, xet_core_structures, or xet_runtime.

    line 24
  2. Very specific:

    After a dependency change, confirm git status --porcelain wasm/*/Cargo.lock is empty.

    line 28

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

Agent Guide for wasm

WebAssembly builds of xet-core. Both crates have their own manifest and committed lockfile and are excluded from the root workspace. Shared conventions are in the root guide.

  • hf_xet_thin_wasm/ — published chunking and hashing for huggingface.js; built with wasm-pack.
  • hf_xet_wasm/ — example upload/download wrapper around XetSession; a CI smoke-test target, not a published SDK. Built with a threaded nightly -Z build-std and wasm-bindgen.
  • ci-smoke/ — Node + Playwright runner for hf_xet_wasm browser scenarios.

Setup

  • Nightly toolchain with the wasm32-unknown-unknown target and rust-src component (hf_xet_wasm/rust-toolchain.toml pins this).
  • wasm-bindgen-cli 0.2.121 and wasm-pack 0.14.0, matching the =0.2.121 wasm-bindgen pin in both Cargo.toml files. Bump all of them together.
  • Node 24 for ci-smoke.

Build and test

CommandPurpose
(cd xet_pkg && ./build_wasm.sh)Compile gate: cargo check of hf-xet for wasm32
(cd wasm/hf_xet_thin_wasm && ./build_wasm.sh)Build the thin package into pkg/
(cd wasm/hf_xet_wasm && ./build_wasm.sh)Build the example wrapper into pkg/
(cd wasm/ci-smoke && npm ci && npx playwright install --with-deps chromium && node run.mjs all)Browser smoke scenarios; needs a built hf_xet_wasm/pkg/

Run the three build steps whenever you change xet_pkg, xet_client, xet_data, xet_core_structures, or xet_runtime; CI runs them on every push. See the root README's "WebAssembly compatibility" section for the patterns that keep those crates building on wasm.

The smoke scenarios talk to the production Hub and CAS. Read scenarios work anonymously; upload scenarios need HF_SMOKE_TEST_TOKEN with write access to xet-team/xet-wasm-test. Run a single scenario with node run.mjs <name> from scenarios/. Scenario files are kebab-case .mjs with camelCase identifiers.

After a dependency change, confirm git status --porcelain wasm/*/Cargo.lock is empty; CI fails on modified lockfiles.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free