@intlpullhq/cli 0.1.3 → 0.1.5

package/README.md

@@ -25,7 +25,7 @@
 - **Real-time Sync** - Watch for changes and auto-update local files
 - **Auto-detect Project** - Automatically finds `.intlpull.json` in parent directories
 - **Multiple Output Formats** - JSON, YAML, TypeScript, Android XML, iOS Strings
-- **CI/CD Ready** - Non-interactive mode for automation pipelines
+- **CI/CD Ready** - Full non-interactive mode support for automation pipelines (no TTY required)
 - **OTA Releases** - Publish over-the-air updates for mobile/web SDKs
 - **Enterprise Workflows** - Approval workflows for translation review
 - **Migration Tools** - Migrate from Lokalise, Crowdin, Phrase, or local files
@@ -498,11 +498,13 @@ npx @intlpullhq/cli migrate from lokalise --api-key <key> --dry-run
 **Options:**
 | Option | Description |
 |--------|-------------|
-| `--api-key <key>` | API key for source platform |
+| `--api-key <key>` | API key for source platform (required in CI/CD) |
 | `--project-id <id>` | Specific project to migrate |
 | `--to <id>` | Target IntlPull project ID |
 | `--dry-run` | Preview without importing |
 
+> **Note:** In non-interactive environments (CI/CD), the `--api-key` flag is required.
+
 ### Workflows (Enterprise)
 
 Manage approval workflows for translation review.
@@ -642,6 +644,24 @@ npx @intlpullhq/cli zendesk disconnect
 
 ## CI/CD Integration
 
+All CLI commands support **non-interactive mode** and work without a TTY. The CLI automatically detects when running in a non-interactive environment (CI/CD pipelines, Docker, scripts) and adjusts its behavior accordingly.
+
+### Non-Interactive Mode
+
+Commands automatically work in non-interactive environments:
+
+| Command | Non-Interactive Behavior |
+|---------|-------------------------|
+| `upload` / `push` | Auto-confirms plan limit warnings |
+| `download` / `pull` | Works with `--quiet` flag |
+| `init` | Auto-detects framework (use `-y` for explicit) |
+| `sync` | Full support |
+| `check` / `fix` | Full support |
+| `diff` | Full support |
+| `import` / `export` | Full support |
+| `migrate files` | Use `--yes` flag to skip prompts |
+| `migrate from` | Requires `--api-key` flag |
+
 ### Docker
 
 ```dockerfile
@@ -654,6 +674,25 @@ RUN npx @intlpullhq/cli sync --quiet
 RUN npm run build
 ```
 
+### GitHub Actions
+
+```yaml
+name: Sync Translations
+on: [push]
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+      - name: Sync translations
+        env:
+          INTLPULL_API_KEY: ${{ secrets.INTLPULL_API_KEY }}
+        run: npx @intlpullhq/cli sync --quiet
+```
+
 ### GitLab CI
 
 ```yaml
@@ -682,6 +721,15 @@ npx @intlpullhq/cli sync --quiet && next build
 npx @intlpullhq/cli check --source en
 ```
 
+### Recommended CI/CD Flags
+
+| Flag | Description |
+|------|-------------|
+| `--quiet` or `-q` | Suppress output except errors |
+| `--dry-run` | Preview changes without applying |
+| `--yes` or `-y` | Skip confirmation prompts |
+| `--no-parallel` | Disable parallel fetching (if rate limited) |
+
 ---
 
 ## Configuration