Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ICLIConfig

Hierarchy

Index

Properties

_base

_base: string
dxcli/config

version

arch

arch: ArchTypes

process.arch

bin

bin: string

bin name of CLI command

cacheDir

cacheDir: string

cache directory to use for CLI

example ~/Library/Caches/mycli or ~/.cache/mycli

commandsDir

commandsDir: string | undefined

full path to command dir of plugin

if there are typescript commands, this will point to the typescript files if they are on disk for development

configDir

configDir: string

config directory to use for CLI

example: ~/.config/mycli

dataDir

dataDir: string

data directory to use for CLI

example: ~/.local/share/mycli

debug

debug: number

debugging level

set by ${BIN}_DEBUG or DEBUG=$BIN

dirname

dirname: string

base dirname to use in cacheDir/configDir/dataDir

engine

engine: IEngine

errlog

errlog: string

points to a file that should be appended to for error logs

example: ~/Library/Caches/mycli/error.log

home

home: string

path to home directory

example: /home/myuser

hooks

hooks: object

normalized full paths to hooks

points to typescript files if available

Type declaration

  • [k: string]: string[]

name

name: string

CLI name from package.json

npmRegistry

npmRegistry: string

npm registry to use for installing plugins

pjson

pjson: IPJSON

full package.json

parsed with read-pkg

platform

platform: PlatformTypes

process.platform

pluginsModule

pluginsModule: string | undefined

if plugins points to a module this is the full path to that module

for dynamic plugin loading

root

root: string

base path of root plugin

shell

shell: string

active shell

tsconfig

tsconfig: TSConfig | undefined

parsed tsconfig.json

userAgent

userAgent: string

user agent to use for http calls

example: mycli/1.2.3 (darwin-x64) node-9.0.0

version

version: string

cli version from package.json

example: 1.2.3

windows

windows: boolean

if windows

Generated using TypeDoc