84e2d4d2b6
* update LICENSE files to MIT/Apache2 * README: update top-level license * update package-level READMEs with license * changeset: license update
45 lines
1.5 KiB
Markdown
45 lines
1.5 KiB
Markdown
# Lexicon CLI Tool
|
|
|
|
Command-line tool to generate Lexicon schemas and APIs.
|
|
|
|
## Usage
|
|
|
|
```
|
|
Usage: lex [options] [command]
|
|
|
|
Lexicon CLI
|
|
|
|
Options:
|
|
-V, --version output the version number
|
|
-h, --help display help for command
|
|
|
|
Commands:
|
|
new [options] <nsid> [outfile] Create a new schema json file
|
|
gen-md <schemas...> Generate markdown documentation
|
|
gen-ts-obj <schemas...> Generate a TS file that exports an array of schemas
|
|
gen-api <outdir> <schemas...> Generate a TS client API
|
|
gen-server <outdir> <schemas...> Generate a TS server API
|
|
help [command] display help for command
|
|
```
|
|
|
|
**Example 1:** Generate an api
|
|
|
|
```
|
|
$ lex gen-api ./api/src ./schemas/com/service/*.json ./schemas/com/another/*.json
|
|
```
|
|
|
|
**Example 2:** Generate a server
|
|
|
|
```
|
|
$ lex gen-server ./server/src/xrpc ./schemas/com/service/*.json ./schemas/com/another/*.json
|
|
```
|
|
|
|
## License
|
|
|
|
This project is dual-licensed under MIT and Apache 2.0 terms:
|
|
|
|
- MIT license ([LICENSE-MIT.txt](https://github.com/bluesky-social/atproto/blob/main/LICENSE-MIT.txt) or http://opensource.org/licenses/MIT)
|
|
- Apache License, Version 2.0, ([LICENSE-APACHE.txt](https://github.com/bluesky-social/atproto/blob/main/LICENSE-APACHE.txt) or http://www.apache.org/licenses/LICENSE-2.0)
|
|
|
|
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.
|