Search
Preparing search index...
The search index is not available
Yarn API
Home
Configuration
Features
CLI
Advanced
GitHub
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
yarnpkg-cli
BaseCommand
Globals
{"Generic Packages":{"@yarnpkg/core":"yarnpkg_core","@yarnpkg/fslib":"yarnpkg_fslib","@yarnpkg/libzip":"yarnpkg_libzip","@yarnpkg/nm":"yarnpkg_nm","@yarnpkg/parsers":"yarnpkg_parsers","@yarnpkg/pnp":"yarnpkg_pnp","@yarnpkg/pnpify":"yarnpkg_pnpify","@yarnpkg/sdks":"yarnpkg_sdks","@yarnpkg/shell":"yarnpkg_shell"},"Yarn Packages":{"@yarnpkg/builder":"yarnpkg_builder","@yarnpkg/cli":"yarnpkg_cli"},"Default Plugins":{"@yarnpkg/plugin-compat":"plugin_compat","@yarnpkg/plugin-dlx":"plugin_dlx","@yarnpkg/plugin-essentials":"plugin_essentials","@yarnpkg/plugin-file":"plugin_file","@yarnpkg/plugin-git":"plugin_git","@yarnpkg/plugin-github":"plugin_github","@yarnpkg/plugin-http":"plugin_http","@yarnpkg/plugin-init":"plugin_init","@yarnpkg/plugin-link":"plugin_link","@yarnpkg/plugin-nm":"plugin_nm","@yarnpkg/plugin-npm":"plugin_npm","@yarnpkg/plugin-npm-cli":"plugin_npm_cli","@yarnpkg/plugin-pack":"plugin_pack","@yarnpkg/plugin-patch":"plugin_patch","@yarnpkg/plugin-pnp":"plugin_pnp"},"Contrib Plugins":{"@yarnpkg/plugin-constraints":"plugin_constraints","@yarnpkg/plugin-exec":"plugin_exec","@yarnpkg/plugin-interactive-tools":"plugin_interactive_tools","@yarnpkg/plugin-stage":"plugin_stage","@yarnpkg/plugin-typescript":"plugin_typescript","@yarnpkg/plugin-version":"plugin_version","@yarnpkg/plugin-workspace-tools":"plugin_workspace_tools"}}
Class BaseCommand
Hierarchy
Command
<
CommandContext
>
BaseCommand
ConstraintsQueryCommand
ConstraintsSourceCommand
ConstraintsCheckCommand
CreateCommand
DlxCommand
AddCommand
BinCommand
CacheCleanCommand
ConfigGetCommand
ConfigSetCommand
ConfigUnsetCommand
ConfigCommand
DedupeCommand
ClipanionCommand
HelpCommand
EntryCommand
VersionCommand
ExecCommand
ExplainPeerRequirementsCommand
SetVersionCommand
ExplainCommand
InfoCommand
YarnCommand
LinkCommand
NodeCommand
PluginCheckCommand
PluginListCommand
SetVersionSourcesCommand
PluginImportCommand
PluginImportSourcesCommand
PluginRemoveCommand
PluginRuntimeCommand
RebuildCommand
RemoveCommand
RunIndexCommand
RunCommand
SetResolutionCommand
UnlinkCommand
UpCommand
WhyCommand
WorkspacesListCommand
WorkspaceCommand
InitCommand
SearchCommand
UpgradeInteractiveCommand
NpmAuditCommand
NpmInfoCommand
NpmLoginCommand
NpmLogoutCommand
NpmPublishCommand
NpmTagListCommand
NpmTagAddCommand
NpmTagRemoveCommand
NpmWhoamiCommand
PackCommand
PatchCommitCommand
PatchCommand
UnplugCommand
StageCommand
VersionApplyCommand
VersionCheckCommand
VersionCommand
WorkspacesFocusCommand
WorkspacesForeachCommand
Properties
cwd
Methods
execute
validateAndExecute
Properties
cwd
cwd
:
undefined
|
string
= Option.String(`--cwd`, {hidden: true})
Methods
Abstract
execute
execute
(
)
:
Promise
<
number
|
void
>
Returns
Promise
<
number
|
void
>
validate
And
Execute
validate
And
Execute
(
)
:
Promise
<
number
>
Returns
Promise
<
number
>
yarnpkg-
cli
Base
Command
cwd
execute
validate
And
Execute
Workspace
Required
Error
Yarn
Cli
fs
plugin
Commands
pnp
File
check
Cwd
get
Base
Cli
get
Cli
get
Core
Configuration
get
Dynamic
Libs
get
Plugin
Configuration
init
Commands
init
Telemetry
open
Workspace
run
run
Exit
run
Yarn
Path
validate
Nodejs
Version
Generated using
TypeDoc