intlayer-cli
npx machina-cli add skill aymericzip/intlayer-skills/intlayer-cli --openclawFiles (1)
SKILL.md
2.6 KB
Intlayer CLI
The intlayer-cli package provides a set of commands to manage Intlayer dictionaries and configuration.
Installation
npm install intlayer-cli
Main CLI Commands
| Command | Description |
|---|---|
npx intlayer build | Builds the Intlayer dictionaries. |
npx intlayer audit | Audits the dictionaries for missing translations. |
npx intlayer live-sync | Synchronizes dictionaries in real-time. |
npx intlayer pull | Pulls dictionaries from a remote source (e.g., Intlayer CMS). |
npx intlayer push | Pushes dictionaries to a remote source. |
npx intlayer test | Runs tests on dictionaries. |
npx intlayer extract | Extract content from component to create dictionary. |
References
Concepts
- Build
- CI
- CLI Overview
- Configuration
- Debug
- Doc Review
- Doc Translate
- Editor
- Fill
- Init
- List
- List Projects
- Live
- Login
- Pull
- Push
- SDK
- Test
- Extract
- Version
- Watch
Packages
Source
git clone https://github.com/aymericzip/intlayer-skills/blob/main/skills/intlayer-cli/SKILL.mdView on GitHub Overview
Intlayer-CLI provides a suite of commands to manage Intlayer dictionaries and configuration from the command line. It supports building dictionaries, auditing translations for gaps, live-syncing content, and pulling/pushing data to a remote source like the Intlayer CMS via npx intlayer <command>.
How This Skill Works
Install the intlayer-cli package and invoke commands with npx intlayer <command> (e.g., build, audit, live-sync, pull, push, test, extract). The CLI reads local dictionary data, validates translations, and communicates with a remote source to generate, update, and synchronize content as needed.
When to Use It
- Auditing translations for missing keys to ensure localization coverage
- Building dictionaries after adding or updating components with translatable strings
- Synchronizing dictionaries in real-time with a remote source (live-sync)
- Pulling the latest dictionaries from a remote source before deployment
- Extracting content from UI components to create or update dictionary entries
Quick Start
- Step 1: npm install intlayer-cli
- Step 2: npx intlayer build
- Step 3: npx intlayer audit && npx intlayer push (or pull) to sync with the remote source
Best Practices
- Run audit before build to catch missing translations early
- Keep local dictionaries in version control and tag releases
- Use live-sync during development for real-time updates
- Test dictionaries with intlayer test before pushing to production
- Review extract outputs to ensure all required keys are included
Example Use Cases
- Audit translations for a new language pack in a React app
- Build dictionaries after introducing a new component with translatable strings
- Live-sync translations while implementing UI changes across locales
- Pull the latest dictionaries prior to a production deployment
- Extract content from a component to create or update dictionary entries
Frequently Asked Questions
Add this skill to your agents