@wuespace/telestion-client-cli

Telestion Client CLI

npm: @wuespace/telestion-client-cli

The command line interface for developing Project-Specific Clients (PSCs) with the Telestion Client ecosystem.

This package is included in PSCs bootstrapped using the Telestion Client CLI by default.

Installation

Simply install the command line interface globally in your workspace:

npm install --global @wuespace/telestion-client-cli

Or, add it as a development dependency to your PSC project:

npm install @wuespace/telestion-client-cli

After installation, check out the options of the cli:

tc-cli --help

For a full reference, check out the help pages for each command or take a look at the PSC Dev Manual in our documentation.

You can find the latest versions (in PDF format) in the Documentation Repo Releases.

Package structure

The package internally uses yargs to build an interactive command line and does all the argument parsing.

The main executable is located in the bin folder. All commands are defined in src/commands and must export some predefined variables. Utility and library functions are exported at src/lib that maybe used in the commands.

Overall, the folder structure, therefore, looks like this:

.
├── bin
│   └── cli.js (the CLI executable)
├── src
│   ├── commands (the CLI commands)
│   │   ├── build.js
│   │   ├── docs.js
│   │   └── [...]
│   ├── lib (library functions for CLI commands)
│   │   ├── build
│   │   │   ├── custom-webpack-loader
│   │   │   │   └── electron-main-import-plugins.js (custom webpack loader for compiling the Electron main thread)
│   │   │   ├── static
│   │   │   │   └── electron-main.js (the Electron Main Thread file used when building Electron Apps from PSCs)
│   │   │   └── [...]
│   │   ├── [...]
│   │   ├── async-exec.js
│   │   └── [...]
│   └── api.js (publicly exposed JS APIs of the CLI, undocumented except in code!)
├── CHANGELOG.md (DO NOT TOUCH! auto-generated changelog for the package)
├── LICENSE
├── package.json
├── README.md (you're here :P)
└── tsconfig.json

Contributing

If you want to contribute to this package, please take a look at the Telestion Client monorepo that manages this package, among other Telestion Client packages.

Contributors

Thank you to all contributors of this repository:

Made with contributors-img.

About

This is part of Telestion, a project by WüSpace e.V..