mirror of https://github.com/hyper-tuner/ini.git
46 lines
1.4 KiB
Markdown
46 lines
1.4 KiB
Markdown
# 📦 HyperTuner INI parser
|
|
|
|
|
|
[](https://github.com/hyper-tuner/ini/actions/workflows/codeql-analysis.yml)
|
|
[](https://codeclimate.com/github/hyper-tuner/ini/maintainability)
|
|
[](https://codeclimate.com/github/hyper-tuner/ini/test_coverage)
|
|
|
|
|
|
## Installation
|
|
|
|
Make sure you have registry specified in the `.npmrc` file:
|
|
|
|
```bash
|
|
@hyper-tuner:registry=https://npm.pkg.github.com
|
|
```
|
|
|
|
Authenticate to GitHub Packages:
|
|
|
|
[authenticating-to-github-packages](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-to-github-packages)
|
|
|
|
Proceed with the installation:
|
|
|
|
```bash
|
|
npm i --save @hyper-tuner/ini
|
|
```
|
|
|
|
## CLI capabilities
|
|
|
|
You can also run this package as a CLI tool.
|
|
|
|
First you need to authenticate to GitHub Packages:
|
|
|
|
```bash
|
|
npm login --scope=@hyper-tuner --registry=https://npm.pkg.github.com
|
|
|
|
> Username: USERNAME
|
|
> Password: TOKEN
|
|
> Email: PUBLIC-EMAIL-ADDRESS
|
|
```
|
|
|
|
No you can run the tool:
|
|
|
|
```bash
|
|
npx hyper-tuner/ini validate test/data/ini/202103.ini
|
|
```
|