https://github.com/pfrankov/onesky-sync
Onesky CLI wrapper over onesky-utils
https://github.com/pfrankov/onesky-sync
cli i18n onesky onesky-cli translation
Last synced: about 1 year ago
JSON representation
Onesky CLI wrapper over onesky-utils
- Host: GitHub
- URL: https://github.com/pfrankov/onesky-sync
- Owner: pfrankov
- Created: 2018-03-31T22:16:35.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-01T22:07:16.000Z (over 8 years ago)
- Last Synced: 2025-03-28T04:23:08.261Z (over 1 year ago)
- Topics: cli, i18n, onesky, onesky-cli, translation
- Language: JavaScript
- Homepage:
- Size: 19.5 KB
- Stars: 4
- Watchers: 0
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# OneSky sync
[](https://www.npmjs.com/package/onesky-sync)
Simple CLI wrapper over [@brainly/onesky-utils](https://github.com/brainly/nodejs-onesky-utils).
## Installation
```bash
npm install -g onesky-sync
```
## Usage
```bash
onesky-sync upload [options]
onesky-sync download [options]
```
##### Common options
| Option | Required | Default Value | Description |
| ------------ | :------: | ------------- | ---------------------------------------------------------------------------------------------------- |
| `api-key` | ✔ | | Api Key can be obtained on Site Settings page on OneSky |
| `secret` | ✔ | | Secret can also be obtained on Site Settings page on OneSky |
| `project-id` | ✔ | | Project ID can be found in the URL `admin/project/dashboard/project/:project-id` on OneSky Dashboard |
You can pass any options from [onesky-utils API](https://github.com/brainly/nodejs-onesky-utils#api)
#### Upload
```bash
onesky-sync upload ./translations/en.json --api-key=111 --secret=111 --project-id=111
onesky-sync upload ./translations/*.json --api-key=111 --secret=111 --project-id=111
```
| Option | Required | Default Value | Description |
| ------------------------ | :------: | -------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `format` | | `HIERARCHICAL_JSON` | File format. ([list here](https://github.com/onesky/api-documentation-platform/blob/master/reference/format.md)) |
| `content` | | From input file | String with the content of the file |
| `keep-strings` | | `false` | Boolean saying if already uploaded strings not present on this file should be deprecated or kept |
| `allow-same-as-original` | | `false` | Keep the translations that are the same as source text |
| `language` | | `en` | Language code |
| `file-name` | | File name from input | Name of translation file |
#### Download
```bash
onesky-sync download ./translations/ --file-name=en.json --language=ru --api-key=111 --secret=111 --project-id=111
onesky-sync download ./translations/ --file-name=en.json --api-key=111 --secret=111 --project-id=111
```
| Option | Required | Default Value | Description |
| ----------- | :------: | -------------------------- | ------------------------ |
| `language` | | All available translations | Language code |
| `file-name` | ✔ | | Name of translation file |