https://github.com/intlify/cli
CLI Tooling for i18n development
https://github.com/intlify/cli
Last synced: about 1 year ago
JSON representation
CLI Tooling for i18n development
- Host: GitHub
- URL: https://github.com/intlify/cli
- Owner: intlify
- License: mit
- Created: 2020-12-25T06:34:51.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-03-15T10:23:42.000Z (over 1 year ago)
- Last Synced: 2025-05-01T03:07:59.079Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 696 KB
- Stars: 12
- Watchers: 5
- Forks: 2
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 🧰 Intlify CLI
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![CI][ci-src]][ci-href]
CLI Tooling for i18n development
## 💿 Installation
### npm
```sh
npm install -g @intlify/cli
```
### yarn
```sh
yarn global add @intlify/cli
```
### yarn
```sh
yarn global add @intlify/cli
```
## 🌟 Features
- the i18n resources compilation
- the attributes annotation for i18n custom block
- the i18n custom block formatting
## 🚀 Usage
```
Usage: intlify [options]
Commands:
intlify compile compile the i18n resources [aliases: cp]
intlify annotate annotate the attributes [aliases: at]
intlify format format for single-file components [aliases: ft]
Options:
--help Show help [boolean]
--version Show version number [boolean]
```
## 🙈 Ignoring
For `annotate` or `format` commands, you can ignore with using `.intlifyignore` or `--ignore` for files passed at the end of the options or `--source` option
### `.intlifyignore`
To exclude files from iles passed at the end of the options or `--source` option, create a `.itnlifyignore` file in the root of your project. `.intlifyignore` uses [gitignore syntax](https://git-scm.com/docs/gitignore#_pattern_format).
example:
```
# Ignore node_modules
node_modules
# ignore artifacts
build
coverage
```
It’s recommended to have a `.intlifyignore` in your project! This way you can run `intlify format —source /path/to/**/*.vue —type custom-block` . to make sure that everything is executed (without mangling files you don’t want, or choking on generated files).
### `--ignore` option
If you can't use `.intlifyignore` for some reason and want to specify a different file, you can use the `--ignore` option to achieve this.
```sh
# ignore with `.gitignore`
intlify format —source /path/to/**/*.vue —type custom-block --ignore .gitignore
```
## 🤝 API
About details, See the [API References](https://www.jsdocs.io/package/@intlify/cli)
## 🌏 I18n
Intlify cli is supporting for I18n.
If you would like to localiize Intlify CLI, you can contribute i18n resource to [locales](https://github.com/intlify/cli/blob/main/locales) directory.
## 📜 Changelog
Details changes for each release are documented in the [CHANGELOG.md](https://github.com/intlify/cli/blob/main/CHANGELOG.md).
## ❗ Issues
Please make sure to read the [Issue Reporting Checklist](https://github.com/intlify/cli/blob/main/.github/CONTRIBUTING.md#issue-reporting-guidelines) before opening an issue. Issues not conforming to the guidelines may be closed immediately.
## ©️ License
[MIT](http://opensource.org/licenses/MIT)
[npm-version-src]: https://img.shields.io/npm/v/@intlify/cli?style=flat&colorA=18181B&colorB=FFAD33
[npm-version-href]: https://npmjs.com/package/@intlify/cli
[npm-downloads-src]: https://img.shields.io/npm/dm/@intlify/cli?style=flat&colorA=18181B&colorB=FFAD33
[npm-downloads-href]: https://npmjs.com/package/@intlify/cli
[ci-src]: https://github.com/intlify/cli/actions/workflows/ci.yaml/badge.svg
[ci-href]: https://github.com/intlify/cli/actions/workflows/ci.yaml