diff --git a/cli/spec.md b/cli/spec.md new file mode 100644 index 00000000..83285320 --- /dev/null +++ b/cli/spec.md @@ -0,0 +1,11 @@ +# Downpour CLI spec +`downpour [command] --opts` +## Commands: +- new - creates/initalizes a depot at the endpoint. Creates manifest.json and speedtest +- connect [name] - connects to an s3 endpoint and saves the endpoint to some sort of credentials file. Name is either as provided or the hostname of the endpoint +- upload - uploads game as described before. Should fail if depot isn't initialized with new from above +- copy - copies between two depots +- mark-exists - modifies depot's manifest.json to show content exists without copying (for third party copies) - maybe throw in checking one or two checks to see if they exist? +- mark-absent - the same as above, but the reverse +- rename - renames an endpoint [NEEDS API ROUTES - can't do yet] +- delete - delete an endpoint [NEEDS API ROUTES - can't do yet]