Commands
Straight from w4ve --help, so this page cannot describe a flag the command does not have.
Every command takes -n
It shows what would happen and writes nothing. When in doubt, run it with -n first.
Overview
usage: w4ve [-h] [--index INDEX] [--refresh] [--dir DIR] [--version]
{init,adopt,list,search,info,profiles,install,update,remove,repair,plugins,configure,http,storage,api,dev,pack,sync,status,doctor,run,start,stop,console,logs} ...
Install and update W4VE pieces.
positional arguments:
{init,adopt,list,search,info,profiles,install,update,remove,repair,plugins,configure,http,storage,api,dev,pack,sync,status,doctor,run,start,stop,console,logs}
init write a w4ve.toml here
adopt write down what is already installed here
list what the catalog has
search find a piece
info everything known about one piece
profiles curated sets of pieces
install download and place a piece
update move to the newest version
remove take a piece out
repair undo an install that was killed halfway
plugins what MCDR plugins this server has
configure answer what a piece needs told to it
http the web server config this server needs
storage what pieces are storing, and its ceiling
api the local API: tokens, and asking it things
dev write a plugin: scaffold it, check it, try it
pack build a .w4ve out of a folder
sync leave the server as w4ve.toml says
status versions, pending restarts and what is running
doctor find what is wrong
run own this server and watch it, in the foreground
start start the server with the guardian already up
stop stop the server, saving first
console attach to the live console
logs read the console or the journal
options:
-h, --help show this help message and exit
--index INDEX catalog path or URL
--refresh ignore the cached catalog
--dir DIR server folder (default: look upwards)
--version show program's version number and exitw4ve init
usage: w4ve init [-h] [--name NAME] [--mc MC] [--client] [--force] [-n] [-y]
options:
-h, --help show this help message and exit
--name NAME what to call this server (default: the folder)
--mc MC Minecraft version, if it cannot be worked out
--client this folder is a game instance, not a server
--force overwrite an existing w4ve.toml
-n, --dry-run say what would happen, change nothing
-y, --yes answer yes to every questionw4ve adopt
usage: w4ve adopt [-h] [-n] [-y]
options:
-h, --help show this help message and exit
-n, --dry-run say what would happen, change nothing
-y, --yes answer yes to every questionw4ve list
usage: w4ve list [-h] [--type TYPE] [--side {server,client}] [--profile PROFILE]
[--installed] [-n] [-y]
options:
-h, --help show this help message and exit
--type TYPE only this kind (fabric-mod, mcdr-plugin...)
--side {server,client}
only what goes on that side
--profile PROFILE only what this profile contains
--installed only what is installed here
-n, --dry-run say what would happen, change nothing
-y, --yes answer yes to every questionw4ve search
usage: w4ve search [-h] [-n] [-y] text
positional arguments:
text words to look for in names, summaries and tags
options:
-h, --help show this help message and exit
-n, --dry-run say what would happen, change nothing
-y, --yes answer yes to every questionw4ve info
usage: w4ve info [-h] [-n] [-y] id
positional arguments:
id the piece to explain
options:
-h, --help show this help message and exit
-n, --dry-run say what would happen, change nothing
-y, --yes answer yes to every questionw4ve profiles
usage: w4ve profiles [-h] [-n] [-y]
options:
-h, --help show this help message and exit
-n, --dry-run say what would happen, change nothing
-y, --yes answer yes to every questionw4ve install
usage: w4ve install [-h] [--profile PROFILE] [--file FILE] [--force] [-n] [-y]
[id[@version] ...]
positional arguments:
id[@version] pieces to install; @version pins one; or the path of a .w4ve
package
options:
-h, --help show this help message and exit
--profile PROFILE install a whole profile at once
--file FILE pick a specific asset by name
--force install over a known conflict or an unsupported version
-n, --dry-run say what would happen, change nothing
-y, --yes answer yes to every questionw4ve update
usage: w4ve update [-h] [-v] [--force] [-n] [-y] [ids ...]
positional arguments:
ids pieces to update (default: all of them)
options:
-h, --help show this help message and exit
-v, --verbose also say what is already up to date
--force update even into a known conflict
-n, --dry-run say what would happen, change nothing
-y, --yes answer yes to every questionw4ve remove
usage: w4ve remove [-h] [-n] [-y] ids [ids ...]
positional arguments:
ids pieces to take out
options:
-h, --help show this help message and exit
-n, --dry-run say what would happen, change nothing
-y, --yes answer yes to every questionw4ve repair
usage: w4ve repair [-h] [-n] [-y]
options:
-h, --help show this help message and exit
-n, --dry-run say what would happen, change nothing
-y, --yes answer yes to every questionw4ve plugins
usage: w4ve plugins [-h] [--folder FOLDER] [--python PYTHON] [--load] [-n] [-y]
[action] [target]
positional arguments:
action reload, unload, load, enable, disable, refresh, list, status
(on the running server)
target which plugin the action is about
options:
-h, --help show this help message and exit
--folder FOLDER where they live (default: plugins)
--python PYTHON the interpreter the plugins will run under (default: a venv in
the server folder, or this one)
--load actually load them, to see which ones run
-n, --dry-run say what would happen, change nothing
-y, --yes answer yes to every questionw4ve configure
usage: w4ve configure [-h] [--all] [--show] [--set name=value] [-n] [-y] id
positional arguments:
id the piece to configure
options:
-h, --help show this help message and exit
--all go through every setting, not only the missing ones
--show what is set and what is not (never prints secrets)
--set name=value set one without prompting (repeatable)
-n, --dry-run say what would happen, change nothing
-y, --yes answer yes to every questionw4ve http
usage: w4ve http [-h] [--out OUT] [-n] [-y] [{nginx,caddy}]
positional arguments:
{nginx,caddy} which web server to write it for (default: nginx)
options:
-h, --help show this help message and exit
--out OUT write it to a file instead of printing
-n, --dry-run say what would happen, change nothing
-y, --yes answer yes to every questionw4ve storage
usage: w4ve storage [-h] [--purge] [-n] [-y]
options:
-h, --help show this help message and exit
--purge make room now, following what each piece declared
-n, --dry-run say what would happen, change nothing
-y, --yes answer yes to every questionw4ve api
usage: w4ve api [-h] [--scope {read,write,admin}] [-n] [-y]
{token,tokens,revoke,get} [name]
positional arguments:
{token,tokens,revoke,get}
token: issue one. tokens: list them. revoke: take one
away. get: ask a route
name the token's name, or the route for `get`
options:
-h, --help show this help message and exit
--scope {read,write,admin}
what the token may do (default: read)
-n, --dry-run say what would happen, change nothing
-y, --yes answer yes to every questionw4ve dev
usage: w4ve dev [-h] [--force] [--verbose] [-n] [-y]
{new,check,run,env,lock} [name]
positional arguments:
{new,check,run,env,lock}
new: scaffold one. check: conformance. run: try it. env:
build its own virtualenv. lock: freeze that environment
into a requirements.txt
name for `new`, what to call it; for the rest, the folder
options:
-h, --help show this help message and exit
--force for `env`, build it again over the existing one
--verbose for `check`, print every line of the conversation
-n, --dry-run say what would happen, change nothing
-y, --yes answer yes to every questionw4ve pack
usage: w4ve pack [-h] [--out OUT] [-n] [-y] folder
positional arguments:
folder folder with a w4ve.json in it
options:
-h, --help show this help message and exit
--out OUT where to leave the package
-n, --dry-run say what would happen, change nothing
-y, --yes answer yes to every questionw4ve sync
usage: w4ve sync [-h] [-n] [-y]
options:
-h, --help show this help message and exit
-n, --dry-run say what would happen, change nothing
-y, --yes answer yes to every questionw4ve status
usage: w4ve status [-h] [-n] [-y]
options:
-h, --help show this help message and exit
-n, --dry-run say what would happen, change nothing
-y, --yes answer yes to every questionw4ve doctor
usage: w4ve doctor [-h] [-n] [-y]
options:
-h, --help show this help message and exit
-n, --dry-run say what would happen, change nothing
-y, --yes answer yes to every questionw4ve run
usage: w4ve run [-h] [--no-start] [--quiet] [-n] [-y]
options:
-h, --help show this help message and exit
--no-start hold the server: start the guardian only
--quiet do not echo the server console here
-n, --dry-run say what would happen, change nothing
-y, --yes answer yes to every questionw4ve start
usage: w4ve start [-h] [-n] [-y] [process]
positional arguments:
process which process (default: the server)
options:
-h, --help show this help message and exit
-n, --dry-run say what would happen, change nothing
-y, --yes answer yes to every questionw4ve stop
usage: w4ve stop [-h] [--grace GRACE] [--force] [-n] [-y] [process]
positional arguments:
process which process (default: the server)
options:
-h, --help show this help message and exit
--grace GRACE seconds to wait before escalating (default: 90)
--force signal the process directly when no guardian is up
-n, --dry-run say what would happen, change nothing
-y, --yes answer yes to every questionw4ve console
usage: w4ve console [-h] [-n] [-y] [process]
positional arguments:
process which process (default: the server)
options:
-h, --help show this help message and exit
-n, --dry-run say what would happen, change nothing
-y, --yes answer yes to every questionw4ve logs
usage: w4ve logs [-h] [-f] [-n LINES] [--journal] [-y] [process]
positional arguments:
process whose console (default: the server)
options:
-h, --help show this help message and exit
-f, --follow keep printing new lines
-n, --lines LINES how many lines to show (default: 40)
--journal the guardian journal instead of the console
-y, --yes answer yes to every question