0.0.2 • Published 9 months ago
@sparklytech/sparkly v0.0.2
sparkly-cli
(This is only a POC for fun - please don't use in production)
Sparkly is an SDK generator for OpenAPI specifications. It helps you generate client SDKs for multiple languages from your OpenAPI 3.0 or 3.1 specifications.
Usage
$ npm install -g @sparklytech/sparkly
$ sparkly COMMAND
running command...
$ sparkly (--version)
@sparklytech/sparkly/0.0.2 darwin-arm64 node-v20.16.0
$ sparkly --help [COMMAND]
USAGE
$ sparkly COMMAND
...
Commands
sparkly build
sparkly build docs [FILE]
sparkly build sdks
sparkly help [COMMAND]
sparkly init
sparkly validate
sparkly validate config [FILE]
sparkly validate spec
sparkly build
Build your SDKs and Docs
USAGE
$ sparkly build
DESCRIPTION
Build your SDKs and Docs
See code: src/commands/build/index.ts
sparkly build docs [FILE]
describe the command here
USAGE
$ sparkly build docs [FILE] [-f] [-n <value>]
ARGUMENTS
FILE file to read
FLAGS
-f, --force
-n, --name=<value> name to print
DESCRIPTION
describe the command here
EXAMPLES
$ sparkly build docs
See code: src/commands/build/docs.ts
sparkly build sdks
Build your SDKs
USAGE
$ sparkly build sdks [-c <value>]
FLAGS
-c, --config=<value> [default: /Users/samir.amzani/Projects/sparkly/sparkly-cli-oclif/.sparkly-config.json] Path to
the SDK config file
DESCRIPTION
Build your SDKs
See code: src/commands/build/sdks.ts
sparkly help [COMMAND]
Display help for sparkly.
USAGE
$ sparkly help [COMMAND...] [-n]
ARGUMENTS
COMMAND... Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for sparkly.
See code: @oclif/plugin-help
sparkly init
Initialize your SDK generation
USAGE
$ sparkly init
DESCRIPTION
Initialize your SDK generation
EXAMPLES
$ sparkly init
See code: src/commands/init/index.ts
sparkly validate
validate your SDK
USAGE
$ sparkly validate
DESCRIPTION
validate your SDK
See code: src/commands/validate/index.ts
sparkly validate config [FILE]
describe the command here
USAGE
$ sparkly validate config [FILE] [-f] [-n <value>]
ARGUMENTS
FILE file to read
FLAGS
-f, --force
-n, --name=<value> name to print
DESCRIPTION
describe the command here
EXAMPLES
$ sparkly validate config
See code: src/commands/validate/config.ts
sparkly validate spec
Validate your API Specification
USAGE
$ sparkly validate spec [-c <value>]
FLAGS
-c, --config=<value> [default: /Users/samir.amzani/Projects/sparkly/sparkly-cli-oclif/.sparkly-config.json] Path to
the SDK config file
DESCRIPTION
Validate your API Specification
See code: src/commands/validate/spec.ts
0.0.2
9 months ago