chore: Add spec.md

This commit is contained in:
quexeky
2026-01-25 08:02:23 +11:00
parent e462fe3efd
commit a9d1c6eea4
+11
View File
@@ -0,0 +1,11 @@
# Downpour CLI spec
`downpour [command] --opts`
## Commands:
- new <path/s3 name> <public endpoint> - creates/initalizes a depot at the endpoint. Creates manifest.json and speedtest
- connect <s3 endpoint> <key> <secret> [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 <game id> <localpath> <path/s3 name> - uploads game as described before. Should fail if depot isn't initialized with new from above
- copy <game id> <version id> <src path/s3 name> <dest path/s3 name> - copies between two depots
- mark-exists <game id> <version id> <path/s3 name> - 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 <game id> <version id> <path/s3 name> - the same as above, but the reverse
- rename <public endpoint> <new public endpoint> - renames an endpoint [NEEDS API ROUTES - can't do yet]
- delete <public endpoint> - delete an endpoint [NEEDS API ROUTES - can't do yet]