# @gi.ts/cli

> The command line interface for gi.ts (type checking for GObject Introspection and GJS)

Latest version **2.0.0-alpha.0** (published 2023-06-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install @gi.ts/cli
pnpm add @gi.ts/cli
yarn add @gi.ts/cli
bun add @gi.ts/cli
```

Provides the command `gi-ts`.

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0-alpha.0 |
| Published | 2023-06-16 |
| First published | 2020-10-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=12.0.0 |
| Dependencies | 6 |
| Unpacked size | 26.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Evan Welsh |
| Maintainers | rockon999, ewlsh |
| Keywords | oclif |

## Links

- npm: https://www.npmjs.com/package/@gi.ts/cli
- Repository: https://gitlab.gnome.org/ewlsh/gi.ts
- Homepage: https://github.com/ewlsh/gi.ts
- Issues: https://gitlab.gnome.org/ewlsh/gi.ts/issues
- npm.io page: https://npm.io/package/@gi.ts/cli

## Dependencies (6)

- [tslib](https://npm.io/package/tslib.md) ^1
- [prettier](https://npm.io/package/prettier.md) ^2.2.1
- [@oclif/core](https://npm.io/package/@oclif/core.md) ^2.8.5
- [@gi.ts/parser](https://npm.io/package/@gi.ts/parser.md) 2.0.0-alpha.0
- [@gi.ts/node-loader](https://npm.io/package/@gi.ts/node-loader.md) 2.0.0-alpha.0
- [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) 5.2.9

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 2.0.0-alpha.0 (latest) — 2023-06-16
- 1.5.10 — 2022-07-06
- 1.5.7 — 2021-07-16
- 1.5.6 — 2021-07-16
- 1.5.5 — 2021-05-01
- 1.5.3 — 2021-05-01
- 1.5.1 — 2021-04-28
- 1.5.0 — 2021-04-28
- 1.4.1 — 2021-01-24
- 1.4.0 — 2021-01-22
- 1.3.0 — 2020-11-14
- 1.2.1 — 2020-10-22
- 1.2.0 — 2020-10-11

## README

@gi.ts/cli
==========

The command line interface for gi.ts (type checking for GObject Introspection and GJS)

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/@gi.ts/cli.svg)](https://npmjs.org/package/@gi.ts/cli)
[![Downloads/week](https://img.shields.io/npm/dw/@gi.ts/cli.svg)](https://npmjs.org/package/@gi.ts/cli)
[![License](https://img.shields.io/npm/l/@gi.ts/cli.svg)](https://github.com/ewlsh/gi.ts/blob/master/package.json)

<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ npm install -g @gi.ts/cli
$ gi-ts COMMAND
running command...
$ gi-ts (--version)
@gi.ts/cli/2.0.0-alpha.0 linux-x64 node-v16.11.0
$ gi-ts --help [COMMAND]
USAGE
  $ gi-ts COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`gi-ts config [FILE]`](#gi-ts-config-file)
* [`gi-ts generate [FILE]`](#gi-ts-generate-file)
* [`gi-ts help [COMMANDS]`](#gi-ts-help-commands)

## `gi-ts config [FILE]`

create docs configurations

```
USAGE
  $ gi-ts config [FILE] [--help] [--lock]

FLAGS
  --help  Show CLI help.
  --lock

DESCRIPTION
  create docs configurations

EXAMPLES
  $ gi-ts config --lock
```

## `gi-ts generate [FILE]`

generate documentation files

```
USAGE
  $ gi-ts generate [FILE] [--all] [--help] [--out <value>] [--format <value>] [--inferGenerics] [--promisify]
    [--propertyCase both|underscore|camel] [--outputFormat file|folder] [--noPrettyPrint] [--noInitTypes] [--withDocs]
    [--versionedOutput] [--versionedImports] [--importPrefix <value>] [--emitMetadata] [--noAdvancedVariants] [-v]

FLAGS
  -v, --verbose            prints detailed per-member generation info
  --all                    Generate all found libraries
  --emitMetadata
  --format=<value>         'dts', 'dts-inline', or 'json' are bundled, 'html' is available via @gi.ts/generator-html.
  --help                   Show CLI help.
  --importPrefix=<value>
  --inferGenerics
  --noAdvancedVariants
  --noInitTypes            Disables strict typing for _init() functions in TypeScript files.
  --noPrettyPrint          Disables the pretty-printer. For .d.ts files this will significantly speed up generation.
  --out=<value>
  --outputFormat=<option>  <options: file|folder>
  --promisify
  --propertyCase=<option>  <options: both|underscore|camel>
  --versionedImports
  --versionedOutput
  --withDocs

DESCRIPTION
  generate documentation files

EXAMPLES
  $ gi-ts generate
```

## `gi-ts help [COMMANDS]`

Display help for gi-ts.

```
USAGE
  $ gi-ts help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for gi-ts.
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.9/src/commands/help.ts)_
<!-- commandsstop -->

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