A better Crowdin CLI focused on ease of use and developer experience.
npm install @aburkov/crowdinA better Crowdin CLI focused on ease of use and developer experience.
Node.js is required to install and run this tool. If you don't have Node.js
installed, we recommend using NVM (Node Version Manager) to install it. You can
find installation instructions for NVM at https://github.com/nvm-sh/nvm.
To install the tool, just run npm install -g @aburkov/crowdin@latest.
Run the tool from the root of JetProfile project. The tool will look for the
configuration file (crowdin/crowdin.config.js) in the project root directory.
| Command | Description |
| --------------------- | --------------------------------------------------------------------------------------------------------- |
| crowdin status | Show the translation status of the Crowdin project branches |
| crowdin push | Push the changes to Crowdin (en_US sources only) |
| crowdin pull [branch] | Pull the changes from Crowdin (translations only), if branch is not provided, it will pull current branch |
| crowdin diff [branch] | Show the diff of the project, if branch is not provided, it will show the diff of the current branch |
Use crowdin help to see all the commands.
You need a Bun to compile the project. You can install it from
here.
| Command | Description |
| ---------------- | ------------------------------------------- |
| bun install | Install dependencies |
| bun run index.ts | Run the script |
| bun bundle | Bundle the script into a single file |
| bun release | Release the new version to the npm registry |
| bun typecheck | Typecheck the project |
| bun api:syncspec | Download the latest spec file from Crowdin |
| bun api:generate | Generate the client |