# lokalise

> A tool to retrieve your localization files from lokali.se

Latest version **0.0.8** (published 2019-09-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install lokalise
pnpm add lokalise
yarn add lokalise
bun add lokalise
```

Provides the command `lokalise`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.8 |
| Published | 2019-09-17 |
| First published | 2017-02-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 249.8 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Karolis Stasaitis |
| Maintainers | carlossless |
| Keywords | lokalise, lokali.se, localization, translation |

## Links

- npm: https://www.npmjs.com/package/lokalise
- Repository: https://github.com/carlossless/lokalise
- Homepage: https://github.com/carlossless/lokalise#readme
- Issues: https://github.com/carlossless/lokalise/issues
- npm.io page: https://npm.io/package/lokalise

## Dependencies (8)

- [lodash](https://npm.io/package/lodash.md) ^4.17.5
- [request](https://npm.io/package/request.md) ^2.79.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^8.1.0
- [mustache](https://npm.io/package/mustache.md) ^3.0.1
- [glob-promise](https://npm.io/package/glob-promise.md) ^3.4.0
- [unzip-stream](https://npm.io/package/unzip-stream.md) ^0.3.0
- [babel-polyfill](https://npm.io/package/babel-polyfill.md) ^6.23.0
- [util.promisify](https://npm.io/package/util.promisify.md) ^1.0.0

## Alternatives

- [messageformat](https://npm.io/package/messageformat.md) — 329.7K weekly downloads
- [@mintlify/scraping](https://npm.io/package/@mintlify/scraping.md) — 294.8K weekly downloads
- [@mintlify/previewing](https://npm.io/package/@mintlify/previewing.md) — 209.5K weekly downloads
- [@mintlify/prebuild](https://npm.io/package/@mintlify/prebuild.md) — 209.5K weekly downloads
- [@mintlify/link-rot](https://npm.io/package/@mintlify/link-rot.md) — 206.3K weekly downloads

## Recent versions

- 0.0.8 (latest) — 2019-09-17
- 0.0.6 — 2018-08-30
- 0.0.5 — 2018-06-22
- 0.0.4 — 2018-06-13
- 0.0.3 — 2017-03-14
- 0.0.2 — 2017-02-08
- 0.0.1 — 2017-02-08

## README

[![Build Status](https://travis-ci.org/carlossless/lokalise.svg?branch=master)](https://travis-ci.org/carlossless/lokalise) [![codecov](https://codecov.io/gh/carlossless/lokalise/branch/master/graph/badge.svg)](https://codecov.io/gh/carlossless/lokalise) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)


# lokalise

An unofficial node client for [lokalise](https://lokali.se) to import and update localizations.

## Usage

```
  Usage: lokalise [options] [config.json]

  Lokali.se client for retrieving localization files.

  Options:

    -V, --version        output the version number
    -t, --token <token>  set the api token
    -p, --project <id>   set the project id
    -o, --output <path>  output Path
    -h, --help           output usage information
```

### .lokalise.json

If no `config.json` file argument is given `lokalise` will search for a `.lokalise.json` file in the work dir. This is useful for having different configurations per different project.

Any `config.json` file should have the following structure:

```
{
  "token": [string] (required) Your locali.se api token,
  "project": [string] (required) Your locali.se project ID,
  "output": [string (required) Path where message files will be stored,
  "keys": [object] (optional, default false) Creates a keys file under output_path (read more about it bellow)
}
```

Most of these options can also be provided via one or more of the overriding command arguments or environment variables. See [src/config.js](src/config.js) for more details.

### Keys File

The optional `keys` configuration fragment creates a file in the specified output path that enumerates your localise message keys.
This may be very useful in your code, for autocompletion & type checking over the allowable message keys, for example.
You can configure the format of the keys file to suit your needs by passing the following object:

```
{
  output: [string] (optional) A name for the keys file, defaults to output/keys.js,
  type: 'es5' | 'es6' (optional, defaults to es5) the output module type,
  flow: [boolean] (optional, default false) if true adds a //@flow annotation at the top so that the keys can be used with flow type checking
}
```

## Contributing

Thanks for wanting to contribute! Take a look at our [Contributing Guide](CONTRIBUTING.md) for notes and how to run tests.

---
_Source: https://npm.io/package/lokalise · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._