ws-creator

The ws-creator command (alias): one subcommand = one module function. Get-Help Invoke-WsCreator -Full

Syntax

Invoke-WsCreator [[-Command] <String>] [[-Machine] <String>] [[-Name] <String>] [-Only <String[]>] [-Apply] [-Force] [-Refresh] [-User <String>] [-PublicKey <String>] [-Port <Int32>] [-Subnet <String>] [-Location <String>]

Description

Subcommands, and the function that does the work (Get-Help <function> for details):

  init <template> <name>   Initialize-WsCreatorMachine   machine folder from a template
  new <machine>            New-WsCreatorMachine          creates the distro and applies everything
  apply <machine>          Update-WsCreatorMachine       reapplies fragments and modules
  purge <machine>          Remove-WsCreatorMachine       deletes the distro
  stop <machine>           Stop-WsCreatorMachine         stops containers, then the distro
  image <machine>          Build-WsCreatorImage          builds the base image
  status <machine>         Get-WsCreatorStatus           distro, disk, cloud-init, unpushed work
  code <machine>           Open-WsCreatorCode            VS Code on the machine's ~/src
  list                     Get-WsCreatorMachineList      templates, machines, distros
  doctor                   Test-WsCreatorHost            workstation check
  help                     Get-Help ws-creator           this help (also --help, or no subcommand)

Commands that change something only show what they would do unless -Apply is given. Machines are read from WS_CREATOR_MACHINES, or %APPDATA%\ws-creator\machines when it is not set.

Parameters

Parameter	Type	Required	Position	Description
-Command	String	false	1	The subcommand. Without one, shows this help.
-Machine	String	false	2	The machine (folder <WS_CREATOR_MACHINES>\<name>); for init, the template.
-Name	String	false	3	init only: the name of the new machine.
-Only	String[]	false	named	apply only: just these fragments or modules, e.g. -Only mise,ssh.
-Apply	SwitchParameter	false	named	Do it. Without it, dry run.
-Force	SwitchParameter	false	named	purge only: purge despite unpushed work.
-Refresh	SwitchParameter	false	named	list only: fetch the git catalogs first.
-User	String	false	named	init only: Linux user (see Get-Help Initialize-WsCreatorMachine).
-PublicKey	String	false	named	init only: public key file in ~\.ssh.
-Port	Int32	false	named	init only: SSH port.
-Subnet	String	false	named	init only: podman subnet.
-Location	String	false	named	init only: folder of the virtual disk.

Examples

ws-creator init dev my-machine -Apply

ws-creator new my-machine -Apply

ws-creator apply my-machine -Only mise -Apply