sinotron/README.md

Simple framework for Typescript Electron projects

# Sinotron

Sinotron is a cli tool that creates an Electron project using electron-vite, and bootstraps a base structure for
Electron app development.

### Installation

```shell
npm install -g sinotron
# You can also use yarn or pnpm or bun
```

# Usage

```shell
Usage: sinotron [options] [command]

Options:
  -V, --version          output the version number
  -h, --help             display help for command

Commands:
  setup [options]                  Setup the framework in the current project root.
  project [options] [projectName]  Create electron-vite project in the current folder.
  api [apiName]                    Generate api client and service files
  help [command]                   display help for command
```

### `project` Command

Create an electron-vite project in the current folder.

```shell
Usage: sinotron project [options] [projectName]

Arguments:
  projectName  The project name

Options:
  -h, --help   display help for command
```

### `setup` Command

Setup the framework in the current project root.

```shell
Usage: sinotron setup [options]

Options:
  --force     Overwrite framework directory if exists
  --vscode    Launch the project in VSCode
  -h, --help  display help for command

```

### `api` Command
Generate api client and service files

```shell
Usage: sinotron api [options] [apiName]

Arguments:
  apiName     The api name.

Options:
  -h, --help  display help for command
```