Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

lichess-org/api

Open more actions menu

Lichess API Docs & Examples

Run locally

cd doc
pnpm install
pnpm dev

or with devenv

devenv up

Then open the URL printed in the terminal (usually http://localhost:5173).

Make modifications to any of the schema yaml files, and the page will rebuild and reload automatically.

Check the yaml files for syntax errors:

pnpm spectral
pnpm lint
pnpm scalar-lint

or with devenv

devenv tasks run api:check

Format the yaml files

pnpm format

Publish (for maintainers)

The docs + npm package will be published automatically each day if there are changes, but if you want to publish changes immediately, you can trigger the publish workflow.

Option 1: In the Github UI, manually dispatch the publish workflow

Option 2: From the command line:

gh workflow run publish

About

Lichess API documentation and examples

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

 
 
 

Contributors

Morty Proxy This is a proxified and sanitized view of the page, visit original site.