@v-one/v-builder-cli
v1.0.1
Published
V-Builder CLI is used for V-Builder widget developer to develop and publish their widget to V-Builder
Readme
V-Builder CLI
V-Builder CLI helps V-Builder widget developers manage their widgets.
Installation
npm install -g @v-one/v-builder-cliGetting Started
Before using any commands, configure the CLI with your VONE URL:
v-builder configThen login with your credentials:
v-builder loginYou're now ready to create and upload widgets!
Available Commands
| Command | Description | | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | v-builder config | Interactive configuration (prompts for VONE Url). | | v-builder config:show | Display current CLI configuration. | | v-builder login | Login to V-Builder (stores auth info locally). | | v-builder logout | Logout and clear stored authentication. | | v-builder new [widgetName] | Create a new widget (prompts for missing info). | | v-builder upload [widgetVersion] | Upload the widget. widgetVersion can be an explicit semver (e.g. 1.2.3) or one of: patch, minor, major (auto-increments current version). |
Command Details
config
v-builder configPrompts:
- VONE Url
config:show
v-builder config:showShows saved configuration values.
login / logout
v-builder login
v-builder logoutLogin stores credentials locally; logout removes them.
new
v-builder new
v-builder new my-widgetPrompts (if not provided via arguments / conditions):
- Widget name (if omitted)
- Category (required)
upload
# Increment patch (default if entered interactively)
v-builder upload patch
# Increment minor
v-builder upload minor
# Increment major
v-builder upload major
# Or set explicit version
v-builder upload 1.4.0If no version argument is supplied you'll be prompted. Accepted values:
- patch | minor | major
- A valid semver version (e.g. 2.0.0)
Help
v-builder --helpRunning the CLI with no arguments also shows help.
Error Handling
Non-zero exit codes on failure; unhandled promise rejections are caught and logged.
Notes
- Interactive prompts can be cancelled (process exits).
- Ensure you are logged in before running upload.
