# @boll/cli
# @boll/cli
# Index
# Enumerations
# Classes
# Type aliases
# Variables
# Functions
# Type aliases
# ParsedCommand
Ƭ ParsedCommand: object
Defined in cli.ts:17
# Type declaration:
- command: "run" | "init"
# Variables
# Const cli
• cli: Cli‹› = new Cli(DefaultLogger)
Defined in bin/run.ts:4
# Const copyFileAsync
• copyFileAsync: promisify = promisify(copyFile)
Defined in config-generator.ts:4
# Const existsAsync
• existsAsync: promisify = promisify(exists)
Defined in tests/cli.test.ts:8
# Const fileExistsAsync
• fileExistsAsync: promisify = promisify(fs.exists)
Defined in cli.ts:7
Defined in main.ts:13
# Const parser
• parser: ArgumentParser‹› = new ArgumentParser({ description: "@boll/cli" })
Defined in cli.ts:9
# Const subParser
• subParser: SubParser‹› = parser.addSubparsers({ description: "commands", dest: "command" })
Defined in cli.ts:10
# Const test
• test: any = baretest("CLI")
Defined in tests/cli.test.ts:10
# Functions
# Const bootstrapConfigurations
▸ bootstrapConfigurations(): void
Defined in config/bootstrap.ts:5
bootstrap configurations for CLI
deprecated
Returns: void
# buildSuite
▸ buildSuite(logger: Logger): Promise‹Suite›
Defined in main.ts:15
Parameters:
| Name | Type |
|---|---|
logger | Logger |
Returns: Promise‹Suite›
# doStuff
▸ doStuff(): Promise‹void›
Defined in bin/run.ts:5
Returns: Promise‹void›
# runBoll
▸ runBoll(logger: Logger): Promise‹boolean›
Defined in main.ts:30
Entry point for external libraries running boll.
Parameters:
| Name | Type | Default |
|---|---|---|
logger | Logger | DefaultLogger |
Returns: Promise‹boolean›
true if success, false if any warnings or errors.
# suite
▸ suite(): Promise‹void›
Defined in tests/all.test.ts:3
Returns: Promise‹void›