bas.sh / w-social-atproto-archive
Archive of https://github.com/w-social-eu/w-social-atproto (see also https://github.com/brw/w-social-atproto-archive)
0
Fork 0

Configure Feed

Select the types of activity you want to include in your feed.

w-social-atproto-archive / packages / lex-cli / CLAUDE.md
1.1 kB

@atproto/lex-cli — Lexicon codegen CLI#

The CLI that turns JSON lexicons (in lexicons/) into TypeScript clients and server handlers. Run indirectly via make codegen from the repo root, or directly inside a package's codegen script.

What it generates#

For each lexicon NSID it emits:

  • Client types — request/response interfaces consumed by @atproto/api
  • Server stubs — handler signatures consumed by @atproto/xrpc-server

Generated files land in each consuming package's src/lexicon/ (or src/client/lexicons.ts).

When to run#

Any time a .json file under lexicons/ is added, removed, or edited:

make codegen
# or, scoped:
pnpm --filter @atproto/pds codegen

The root precodegen step builds lex-cli first, so a make codegen from a clean tree is safe.

Don't edit generated files#

Anything under src/lexicon/ in a consuming package is regenerated. Treat them as build artifacts. If you need to influence the output, the change goes in the lexicon JSON or in lex-cli's templates.

See also#

  • lexicons/CLAUDE.md — what lives where in the lexicon tree