Skip to content

Latest commit

 

History

History

README.md

@atproto/lex-installer

Package manager for Lexicon documents. This is the engine behind the lex install command: it resolves Lexicons from the network by NSID, writes them to a local directory, and tracks their versions (CIDs) in a lexicons.json manifest.

import { install } from '@atproto/lex-installer'

await install({
  lexicons: './lexicons',
  manifest: './lexicons.json',
  add: ['app.bsky.feed.post'],
  save: true,
})

Most projects should use the lex install CLI from @atproto/lex rather than calling this package directly.

License

This project is dual-licensed under MIT and Apache 2.0 terms:

Downstream projects and end users may chose either license individually, or both together, at their discretion. The motivation for this dual-licensing is the additional software patent assurance provided by Apache 2.0.