Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update README to include available commands and options #4

Merged
merged 1 commit into from
Dec 2, 2024
+9 −4
Merged

docs: update README to include available commands and options #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,15 @@ A CLI tool to synchronize and manage translations across multiple target files f
npm i -D @tripouille/i18n-cli
```

## Available commands

You can run --help to see the available commands.

| Command | Alias | Description | Options |
| ------- | ----- | ----------- | ------- |
| `status` | `s` | Show the status of the translation files | `-v, --verbose`: Show the tokens that require changes<br>`-vv, --very-verbose`: Show the tokens that require changes and the associated languages<br>`-foc, --fail-on-changes`: Fail if there are tokens that require changes |
| `sync` | - | Synchronize translation files | `-lr, --limit-retrieve <limit>`: Limit the number of tokens to retrieve |

## Usage

### Step 1: Create your CLI
Expand All @@ -33,10 +42,6 @@ bun run ./cli.ts status

This command will execute the `status` command of your CLI.

## Available commands

You can run --help to see the available commands.

## Create i18n CLI params

| Property | Required | Description |
Expand Down
Loading