@gi.ts/cli

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

Usage no npm install needed!

<script type="module">
  import giTsCli from 'https://cdn.skypack.dev/@gi.ts/cli';
</script>

README

@gi.ts/cli

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

oclif Version Downloads/week License

Usage

$ npm install -g @gi.ts/cli
$ gi-ts COMMAND
running command...
$ gi-ts (-v|--version|version)
@gi.ts/cli/1.5.7 linux-x64 node-v12.18.3
$ gi-ts --help [COMMAND]
USAGE
  $ gi-ts COMMAND
...

Commands

gi-ts config

create docs configurations

USAGE
  $ gi-ts config

OPTIONS
  --help  show CLI help
  --lock

EXAMPLE
  $ gi-ts config --lock

gi-ts generate [FILE]

generate documentation files

USAGE
  $ gi-ts generate [FILE]

OPTIONS
  -v, --verbose                           prints detailed per-member generation info
  --all                                   Generate all found libraries
  --emitMetadata
  --format=format                         'dts' or 'json' are bundled, 'html' is available via @gi.ts/generator-html.
  --help                                  show CLI help
  --importPrefix=importPrefix
  --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=out

  --outputFormat=(file|folder)

  --promisify

  --propertyCase=(both|underscore|camel)

  --versionedImports

  --versionedOutput

  --withDocs

EXAMPLE
  $ gi-ts generate

gi-ts help [COMMAND]

display help for gi-ts

USAGE
  $ gi-ts help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help