kalicyh/1Panel Rust CLI

Deploy static sites and Docker compose updates to 1Panel using the Rust 1panel-cli binary.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
commandRust CLI command to run: deploy, server-test, list-websites, list-composes, deploy-compose-update, deploy-all, deploy-all-compose, image-export, image-upload, deploy-load, or help.nodeploy
help-commandSubcommand to show help for when command is help.no""
versionRelease tag to download. Leave empty to use the action ref when it is a v* tag, otherwise the latest release.no""
repositoryRepository that publishes the Rust release assets.no""
targetRelease target asset suffix. Leave empty for automatic Linux x64/arm64 detection.no""
binary-urlDirect URL to a 1panel-cli binary. Overrides repository/version/target download.no""
binary-pathExisting local path to a 1panel-cli binary. Useful for local action tests.no""
github-tokenOptional token for downloading release assets from private repositories or avoiding rate limits.no""
verify-checksumVerify downloaded release assets against SHA256SUMS when available.notrue
base-url1Panel base URL, for example https://panel.example.com.no""
api-key1Panel API key.no""
host1Panel host. Prefer base-url unless host/port are needed separately.no""
port1Panel port.no""
insecureSkip TLS certificate verification.nofalse
jsonPass --json and expose stdout as the result-json output.notrue
non-interactivePass --non-interactive for static deploy.notrue
pathStatic build directory for the deploy command.no""
domainWebsite domain for static deploy.no""
group-idWebsite group ID for automatic static website creation.no""
aliasWebsite alias when creating a missing static website.no""
create-if-missingCreate the static website when it does not exist.nofalse
yesPass --yes for static deploy.nofalse
infoOptional list-composes info filter.no""
image-tagDocker image tag for image-export, deploy-all, and deploy-all-compose.no""
outputLocal tar output path for image-export.no""
inputLocal tar input path for image-upload.no""
remote-dirRemote 1Panel temp directory for image uploads.no""
remote-pathRemote image tar path for deploy-load.no""
keep-local-tarKeep the temporary local image tar after deploy-all or deploy-all-compose.nofalse
compose-name1Panel compose name. If empty, the Rust CLI infers it from compose-path.no""
compose-pathRemote docker-compose.yml path on 1Panel.no""
to-imageTarget image for compose updates. For deploy-all-compose, empty defaults to image-tag.no""
serviceOptional compose service name to update.no""
from-imageOptional current image filter for compose updates.no""
dry-runPreview compose image changes without writing them.nofalse
applyApply compose up. Empty uses the Rust CLI default for the selected command.no""
namedescription
binary-pathInstalled Rust CLI binary path.
result-jsonRaw stdout from the Rust CLI when json is enabled.