@intlpullhq/cli 0.1.7 → 0.1.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +59 -15
- package/dist/index.js +3174 -2345
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -19,6 +19,31 @@
|
|
|
19
19
|
|
|
20
20
|
---
|
|
21
21
|
|
|
22
|
+
## Table of Contents
|
|
23
|
+
|
|
24
|
+
| Section | Description |
|
|
25
|
+
|---------|-------------|
|
|
26
|
+
| [Features](#features) | Key capabilities of the CLI |
|
|
27
|
+
| [Installation](#installation) | How to install the CLI |
|
|
28
|
+
| [Quick Start](#quick-start) | Get started in 4 commands |
|
|
29
|
+
| [Authentication](#authentication) | Login, API keys, and auth methods |
|
|
30
|
+
| [Commands Reference](#commands-reference) | All available commands |
|
|
31
|
+
| ↳ [Initialize](#initialize-project) | Set up IntlPull in your project |
|
|
32
|
+
| ↳ [Upload / Push](#upload--push) | Upload translation keys |
|
|
33
|
+
| ↳ [Download / Pull](#download--pull) | Download translations |
|
|
34
|
+
| ↳ [Sync](#sync) | One-time sync for CI/CD |
|
|
35
|
+
| ↳ [Listen / Watch](#listen--watch) | Real-time sync during dev |
|
|
36
|
+
| ↳ [Import / Export](#import) | Bulk import/export translations |
|
|
37
|
+
| ↳ [OTA Releases](#ota-releases) | Over-the-air updates |
|
|
38
|
+
| ↳ [Migration](#migration) | Migrate from other platforms |
|
|
39
|
+
| [CI/CD Integration](#cicd-integration) | GitHub Actions, GitLab CI, Docker |
|
|
40
|
+
| [Configuration](#configuration) | Project config and output patterns |
|
|
41
|
+
| ↳ [Output Patterns](#output-patterns-namespace-support) | Namespace file structures |
|
|
42
|
+
| [Tips & Best Practices](#tips--best-practices) | Recommended usage patterns |
|
|
43
|
+
| [Support](#support) | Get help |
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
22
47
|
## Features
|
|
23
48
|
|
|
24
49
|
- **Parallel Downloads** - Fetch translations by namespace concurrently for blazing fast syncs
|
|
@@ -792,35 +817,54 @@ npx @intlpullhq/cli pull --output "locales/[namespace]/[locale].json"
|
|
|
792
817
|
|
|
793
818
|
**Important:** Ensure your i18n library's configuration matches the output path:
|
|
794
819
|
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
|
|
798
|
-
|
|
820
|
+
| Library | Config Update Required |
|
|
821
|
+
|---------|----------------------|
|
|
822
|
+
| **next-intl** | Update `src/i18n/request.ts` to load from the correct path |
|
|
823
|
+
| **i18next / react-i18next** | Update `backend.loadPath` in your i18n config |
|
|
824
|
+
| **Chrome Extension** | Must use `_locales/[locale]/messages.json` (Chrome requirement) |
|
|
799
825
|
|
|
800
826
|
### Environment Variables
|
|
801
827
|
|
|
802
828
|
| Variable | Description |
|
|
803
829
|
|----------|-------------|
|
|
804
|
-
| `INTLPULL_API_KEY` | API key for authentication |
|
|
805
|
-
| `
|
|
830
|
+
| `INTLPULL_API_KEY` | API key for authentication (required) |
|
|
831
|
+
| `INTLPULL_PROJECT_ID` | Default project ID |
|
|
832
|
+
| `INTLPULL_DEBUG` | Enable debug logging (`true`/`false`) |
|
|
806
833
|
|
|
807
834
|
---
|
|
808
835
|
|
|
809
836
|
## Tips & Best Practices
|
|
810
837
|
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
|
|
838
|
+
| Practice | Recommendation |
|
|
839
|
+
|----------|----------------|
|
|
840
|
+
| 🔑 **API Keys** | Use project-scoped keys for auto-detection (no `--project` flag needed) |
|
|
841
|
+
| ⚡ **Parallel Mode** | Enabled by default — downloads namespaces concurrently |
|
|
842
|
+
| 🤫 **CI/CD Output** | Use `--quiet` for minimal, machine-friendly logs |
|
|
843
|
+
| 🔍 **Preview Changes** | Use `--dry-run` before applying destructive operations |
|
|
844
|
+
| 🌿 **Branch Workflows** | CLI auto-detects git branch for branch-based translations |
|
|
845
|
+
| 📦 **Namespace Files** | Use output patterns like `[locale]/[namespace].json` for organized files |
|
|
816
846
|
|
|
817
847
|
---
|
|
818
848
|
|
|
819
849
|
## Support
|
|
820
850
|
|
|
821
|
-
|
|
822
|
-
|
|
851
|
+
| Resource | Link |
|
|
852
|
+
|:---------|:-----|
|
|
853
|
+
| 📚 Documentation | [docs.intlpull.com](https://docs.intlpull.com) |
|
|
854
|
+
| 📧 Email Support | [support@intlpull.com](mailto:support@intlpull.com) |
|
|
855
|
+
| 🐛 GitHub Issues | [github.com/intlpullhq/cli/issues](https://github.com/intlpullhq/cli/issues) |
|
|
856
|
+
| 💬 Discord | [discord.gg/intlpull](https://discord.gg/intlpull) |
|
|
857
|
+
|
|
858
|
+
---
|
|
823
859
|
|
|
824
|
-
|
|
860
|
+
<p align="center">
|
|
861
|
+
<a href="#features">Features</a> •
|
|
862
|
+
<a href="#installation">Installation</a> •
|
|
863
|
+
<a href="#commands-reference">Commands</a> •
|
|
864
|
+
<a href="#cicd-integration">CI/CD</a> •
|
|
865
|
+
<a href="#configuration">Config</a>
|
|
866
|
+
</p>
|
|
825
867
|
|
|
826
|
-
|
|
868
|
+
<p align="center">
|
|
869
|
+
MIT © <a href="https://intlpull.com">IntlPull</a>
|
|
870
|
+
</p>
|