@vltpkg/cli-sdk/config/definition

Type Aliases

Commands

type Commands = typeof commands

Defined in: src/cli-sdk/src/config/definition.ts:98

---

RecordField

type RecordField = (typeof recordFields)[number]

Defined in: src/cli-sdk/src/config/definition.ts:119

Variables

commandAliases

const commandAliases: Map<string, string[]>

Defined in: src/cli-sdk/src/config/definition.ts:85

Canonical command names mapped to an array of its aliases

---

commands

const commands: object

Defined in: src/cli-sdk/src/config/definition.ts:77

Command aliases mapped to their canonical names

Type declaration

?

readonly ?: "help" = 'help';

add

readonly add: "install" = 'install';

b

readonly b: "build" = 'build';

bugs

readonly bugs: "bugs" = 'bugs';

build

readonly build: "build" = 'build';

cache

readonly cache: "cache" = 'cache';

ci

readonly ci: "ci" = 'ci';

config

readonly config: "config" = 'config';

create

readonly create: "create" = 'create';

docs

readonly docs: "docs" = 'docs';

exec

readonly exec: "exec" = 'exec';

exec-cache

readonly exec-cache: "exec-cache" = 'exec-cache';

exec-local

readonly exec-local: "exec-local" = 'exec-local';

h

readonly h: "help" = 'help';

help

readonly help: "help" = 'help';

i

readonly i: "install" = 'install';

init

readonly init: "init" = 'init';

install

readonly install: "install" = 'install';

list

readonly list: "list" = 'list';

login

readonly login: "login" = 'login';

logout

readonly logout: "logout" = 'logout';

ls

readonly ls: "list" = 'list';

p

readonly p: "pkg" = 'pkg';

pack

readonly pack: "pack" = 'pack';

ping

readonly ping: "ping" = 'ping';

pkg

readonly pkg: "pkg" = 'pkg';

pub

readonly pub: "publish" = 'publish';

publish

readonly publish: "publish" = 'publish';

q

readonly q: "query" = 'query';

query

readonly query: "query" = 'query';

r

readonly r: "run" = 'run';

repo

readonly repo: "repo" = 'repo';

rm

readonly rm: "uninstall" = 'uninstall';

run

readonly run: "run" = 'run';

run-exec

readonly run-exec: "run-exec" = 'run-exec';

run-script

readonly run-script: "run" = 'run';

rx

readonly rx: "run-exec" = 'run-exec';

token

readonly token: "token" = 'token';

u

readonly u: "update" = 'update';

uninstall

readonly uninstall: "uninstall" = 'uninstall';

update

readonly update: "update" = 'update';

version

readonly version: "version" = 'version';

whoami

readonly whoami: "whoami" = 'whoami';

x

readonly x: "exec" = 'exec';

xc

readonly xc: "exec-cache" = 'exec-cache';

xl

readonly xl: "exec-local" = 'exec-local';

---

defaultView

const defaultView: 'json' | 'human'

Defined in: src/cli-sdk/src/config/definition.ts:5

---

definition

const definition: Jack<
  object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object
>

Defined in: src/cli-sdk/src/config/definition.ts:163

---

recordFields

const recordFields: readonly [
  'git-hosts',
  'registries',
  'git-host-archives',
  'scope-registries',
  'jsr-registries',
]

Defined in: src/cli-sdk/src/config/definition.ts:111

Fields that are parsed as a set of key=value pairs

Functions

defaultEditor()

function defaultEditor(): string

Defined in: src/cli-sdk/src/config/definition.ts:14

Returns

string

---

getCommand()

function getCommand(
  s?,
):
  | undefined
  | 'version'
  | 'bugs'
  | 'build'
  | 'cache'
  | 'ci'
  | 'config'
  | 'docs'
  | 'exec'
  | 'exec-cache'
  | 'exec-local'
  | 'help'
  | 'init'
  | 'install'
  | 'list'
  | 'login'
  | 'logout'
  | 'pack'
  | 'ping'
  | 'pkg'
  | 'publish'
  | 'query'
  | 'repo'
  | 'run'
  | 'run-exec'
  | 'token'
  | 'uninstall'
  | 'update'
  | 'whoami'
  | 'create'

Defined in: src/cli-sdk/src/config/definition.ts:100

Parameters

s?

string

Returns

| undefined | "version" | "bugs" | "build" | "cache" | "ci" | "config" | "docs" | "exec" | "exec-cache" | "exec-local" | "help" | "init" | "install" | "list" | "login" | "logout" | "pack" | "ping" | "pkg" | "publish" | "query" | "repo" | "run" | "run-exec" | "token" | "uninstall" | "update" | "whoami" | "create"

---

getSortedCliOptions()

function getSortedCliOptions(): string[]

Defined in: src/cli-sdk/src/config/definition.ts:731

Returns

string[]

---

getSortedKeys()

function getSortedKeys(): string[]

Defined in: src/cli-sdk/src/config/definition.ts:742

Returns

string[]

---

isRecordField()

function isRecordField(
  s,
): s is
  | 'registries'
  | 'git-hosts'
  | 'git-host-archives'
  | 'scope-registries'
  | 'jsr-registries'

Defined in: src/cli-sdk/src/config/definition.ts:121

Parameters

s

string

Returns

s is “registries” | “git-hosts” | “git-host-archives” | “scope-registries” | “jsr-registries”