cli-options.md

Command-line options

Available commands

• skivvy init
• skivvy install
• skivvy uninstall
• skivvy update
• skivvy list
• skivvy config get
• skivvy config set
• skivvy run

You can run skivvy (without any arguments) or skivvy [command] --help for help at any point.

skivvy init

Create a Skivvy project in the current directory

Options:

Option	Required	Default	Description
--path, -P	No	Current path	Path to Skivvy project
--verbose, -v	No	false	Verbose error output

skivvy install <package>, [package...]

Add packages to the current project (see adding tasks)

Aliases:

• skivvy i

Options:

Option	Required	Default	Description
package	Yes	N/A	Package(s) to install
--path, -P	No	Current path	Path to Skivvy project
--verbose, -v	No	false	Verbose error output

skivvy uninstall <package>, [package...]

Remove packages from the current project

Aliases:

• skivvy rm
• skivvy un

Options:

Option	Required	Default	Description
package	Yes	N/A	Package(s) to uninstall
--path, -P	No	Current path	Path to Skivvy project
--verbose, -v	No	false	Verbose error output

skivvy update [package...]

Update package(s) within the current project

If package is not specified, all packages will be updated.

Aliases:

• skivvy u
• skivvy up

Options:

Option	Required	Default	Description
package	No	N/A	Package(s) to update
--path, -P	No	Current path	Path to Skivvy project
--verbose, -v	No	false	Verbose error output

skivvy list

List this project's installed tasks

Aliases:

• skivvy l
• skivvy ls

Options:

Option	Required	Default	Description
--quiet, -q	No	false	Non-verbose output
--path, -P	No	Current path	Path to Skivvy project
--verbose, -v	No	false	Verbose error output

skivvy config get

View project/package/task configuration (see configuring tasks)

If no --task, --package or --env is specified, the default environment configuration will be used.

Aliases:

• skivvy cfg get
• skivvy cfg g
• skivvy c get
• skivvy c g

Options:

Option	Required	Default	Description
--task, -t	No	null	Task name
--target, -T	No	null	Target name for the specified task
--package, -p	No	null	Task package
--env, -e	No	null	Environment name
--path, -P	No	Current path	Path to Skivvy project
--verbose, -v	No	false	Verbose error output

skivvy config set

Update project/package/task configuration (see configuring tasks)

If no --task, --package or --env is specified, the default environment configuration will be updated.

The --config option can be used to express complex objects in a number of ways:

• Dot notation

   skivvy config set --config.greeting=Hello --config.user=world

• JSON objects

   skivvy config set --config="{ \"greeting\": \"Hello\", \"user\": \"world\" }"

• Arrays

   skivvy config set --task=greet --config=hello --config=goodbye

• JSON Arrays

   skivvy config set --task=greet --config="[\"hello\", \"goodbye\"]"

Aliases:

• skivvy cfg set
• skivvy cfg s
• skivvy c set
• skivvy c s

Options:

Option	Required	Default	Description
--config, -c	Yes	N/A	Configuration updates
--task, -t	No	null	Task to configure
--target, -T	No	null	Target to configure for the specified task
--package, -p	No	null	Task package to configure
--env, -e	No	null	Environment to configure
--path, -P	No	Current path	Path to Skivvy project
--verbose, -v	No	false	Verbose error output

skivvy run <task> [task...]

Run task(s) within the current project (see running tasks)

By default, the working directory is set to the project path. You can optionally specify a custom working directory by passing the --cwd argument, in which case the --path argument is relative to the custom working directory.

Aliases:

• skivvy r

Options:

Option	Required	Default	Description
task	Yes	N/A	Task(s) to run
--config, -c	No	null	Task configuration overrides
--env, -e	No	null	Environment name
--cwd, -C	No	Current path	Custom working directory
--path, -P	No	Current path	Path to Skivvy project
--verbose, -v	No	false	Verbose error output