Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vikadata/widget-cli

Command line tool help you to build awesome vika widget
https://github.com/vikadata/widget-cli

Last synced: 3 months ago
JSON representation

Command line tool help you to build awesome vika widget

Host: GitHub
URL: https://github.com/vikadata/widget-cli
Owner: vikadata
Created: 2022-06-27T08:14:48.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2023-03-24T07:38:19.000Z (over 1 year ago)
Last Synced: 2024-07-16T17:13:45.896Z (4 months ago)
Language: TypeScript
Homepage: https://vika.cn/developers/
Size: 1010 KB
Stars: 3
Watchers: 7
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md

Awesome Lists containing this project

awesome-vikadata - widget-cli

README

        @vikadata/widget-cli

====================

help you build awesome vika widget

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)

[![Version](https://img.shields.io/npm/v/@vikadata/widget-cli.svg)](https://npmjs.org/package/@vikadata/widget-cli)

[![Downloads/week](https://img.shields.io/npm/dw/@vikadata/widget-cli.svg)](https://npmjs.org/package/@vikadata/widget-cli)

[![License](https://img.shields.io/npm/l/@vikadata/widget-cli.svg)](https://github.com/vikadata/widget-cli/blob/master/package.json)

* [Docs](https://vika.cn/developers/widget/introduction)

* [Usage](#usage)

* [Commands](#commands)

# Usage

```sh-session

$ npm install -g @vikadata/widget-cli

$ widget-cli COMMAND

running command...

$ widget-cli (-v|--version|version)

@vikadata/widget-cli/0.0.18 darwin-x64 node-v16.15.0

$ widget-cli --help [COMMAND]

USAGE

  $ widget-cli COMMAND

...

```

# Commands

* [`widget-cli auth [TOKEN]`](#widget-cli-auth-token)

* [`widget-cli help [COMMAND]`](#widget-cli-help-command)

* [`widget-cli init`](#widget-cli-init)

* [`widget-cli list-release [PACKAGEID]`](#widget-cli-list-release-packageid)

* [`widget-cli release`](#widget-cli-release)

* [`widget-cli rollback [PACKAGEID] [VERSION]`](#widget-cli-rollback-packageid-version)

* [`widget-cli start`](#widget-cli-start)

* [`widget-cli submit`](#widget-cli-submit)

* [`widget-cli unpublish [PACKAGEID]`](#widget-cli-unpublish-packageid)

## `widget-cli auth [TOKEN]`

Login authentication, and cache the API Token

```

USAGE

  $ widget-cli auth [TOKEN]

ARGUMENTS

  TOKEN  Your API Token

OPTIONS

  -h, --host=host  Specifies the host of the server, such as https://vika.cn

EXAMPLE

  $ widget-cli auth [apiToken] --host [host]

  Succeed!

```

_See code: [lib/commands/auth.js](https://github.com/vikadata/widget-cli/blob/v0.0.18/lib/commands/auth.js)_

## `widget-cli help [COMMAND]`

display help for widget-cli

```

USAGE

  $ widget-cli help [COMMAND]

ARGUMENTS

  COMMAND  command to show help for

OPTIONS

  --all  see all commands in CLI

```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.3.1/src/commands/help.ts)_

## `widget-cli init`

Create a widget project and register it in your space

```

USAGE

  $ widget-cli init

OPTIONS

  -c, --name=name            Name your widget and project

  -h, --host=host            Specifies the host of the server, such as https://vika.cn

  -p, --packageId=packageId  The widget package id

  -s, --spaceId=spaceId      In which space to put the widget on

  -t, --token=token          Your API Token

  -u, --template=template    The template code zip from vika or github

EXAMPLE

  $ widget-cli init

  your widget: my-widget is successfully created, cd my-widget/ check it out!

```

_See code: [lib/commands/init.js](https://github.com/vikadata/widget-cli/blob/v0.0.18/lib/commands/init.js)_

## `widget-cli list-release [PACKAGEID]`

List all version information for your widget package release

```

USAGE

  $ widget-cli list-release [PACKAGEID]

ARGUMENTS

  PACKAGEID  The widget package you want to unpublish

OPTIONS

  -g, --global       Specify global widget package

  -h, --host=host    Specifies the host of the server, such as https://vika.cn

  -t, --token=token  Your API Token

EXAMPLE

  $ widget-cli list-release [packageId]

  Succeed!

```

_See code: [lib/commands/list-release.js](https://github.com/vikadata/widget-cli/blob/v0.0.18/lib/commands/list-release.js)_

## `widget-cli release`

Release your widget package

```

USAGE

  $ widget-cli release

OPTIONS

  -h, --host=host        Specifies the host of the server, such as https://vika.cn

  -t, --token=token      Your API Token

  -v, --version=version  Specifies the version of the project

  --ci                   Run in CI mode, no version prompt

EXAMPLE

  $ widget-cli release

  Succeed!

```

_See code: [lib/commands/release.js](https://github.com/vikadata/widget-cli/blob/v0.0.18/lib/commands/release.js)_

## `widget-cli rollback [PACKAGEID] [VERSION]`

Rollback the widget package to the specified version

```

USAGE

  $ widget-cli rollback [PACKAGEID] [VERSION]

ARGUMENTS

  PACKAGEID  The widget package you want to rollback

  VERSION    The version of the widget package you want to rollback

OPTIONS

  -g, --global       Specify global widget package

  -h, --host=host    Specifies the host of the server, such as https://vika.cn

  -t, --token=token  Your API Token

EXAMPLE

  $ widget-cli rollback [packageId] [version] --host [host] --token [token]

  Succeed!

```

_See code: [lib/commands/rollback.js](https://github.com/vikadata/widget-cli/blob/v0.0.18/lib/commands/rollback.js)_

## `widget-cli start`

Start current widget project in develop mode

```

USAGE

  $ widget-cli start

OPTIONS

  -o, --protocol=protocol  [default: https] Specifies the protocol of the local server

  -p, --port=port          [default: 9000] Specifies the port of the local server

  --debug                  Show debug information for cli it self

EXAMPLE

  $ widget-cli start

  Compiling...

```

_See code: [lib/commands/start.js](https://github.com/vikadata/widget-cli/blob/v0.0.18/lib/commands/start.js)_

## `widget-cli submit`

Submit your widget package

```

USAGE

  $ widget-cli submit

OPTIONS

  -h, --host=host        Specifies the host of the server, such as https://vika.cn

  -t, --token=token      Your API Token

  -v, --version=version  Specifies the version of the project

  --ci                   Run in CI mode, no prompt

EXAMPLE

  $ widget-cli submit

  Succeed!

```

_See code: [lib/commands/submit.js](https://github.com/vikadata/widget-cli/blob/v0.0.18/lib/commands/submit.js)_

## `widget-cli unpublish [PACKAGEID]`

Unpublish your widget package

```

USAGE

  $ widget-cli unpublish [PACKAGEID]

ARGUMENTS

  PACKAGEID  The widget package you want to unpublish

OPTIONS

  -g, --global       Specify global widget package

  -h, --host=host    Specifies the host of the server, such as https://vika.cn

  -t, --token=token  Your API Token

  --noConfirm        Do not show confirm

EXAMPLE

  $ widget-cli unpublish

  Succeed!

```

_See code: [lib/commands/unpublish.js](https://github.com/vikadata/widget-cli/blob/v0.0.18/lib/commands/unpublish.js)_