Skip to main content

CLI Reference

Commands read ~/.certone/config.yaml for the runtime user by default. Use --config to select another path; omit it when using the default. Docker environment-variable mode uses --env, which cannot be combined with --config.

CommandPurposePerforms deployment?
certone helpShow entry-point helpNo
certone versionShow version, OS, and architectureNo
certone initInteractively create default configuration and credentialsNo
certone init --template --config /absolute/path/config.yamlCreate a template without overwriting an existing fileNo, but writes configuration
certone check --config …Check configuration and basic local prerequisitesNo
certone doctor --config …Run local diagnosticsNo
certone doctor --network --config …Run local diagnostics and check platform authentication and metadataNo
certone sync --once --prepare --config …Prepare file outputs before an application's first start; skip check/reload/verifyWrites files, but does not report completed deployment
certone sync --once --config …Perform one synchronization cycleYes; writes depend on differences and tasks
certone run --config …Maintain certificates continuouslyYes
certone exec --config … -- application-commandPrepare certificates, start the application, and maintain certificatesYes; also starts the application
certone status --config …Read the saved status in plain languageNo
certone status --json --config …Read the saved snapshot as JSONNo
certone diagnose --config … --output fileExport diagnostic informationNo, but writes a diagnostic file
certone service install/start/stop/restart/status/uninstall --config …Manage the system serviceStarting or restarting triggers synchronization

check and doctor probe write access by briefly creating and removing a temporary file in the nearest existing output/state directory; they do not create certificate outputs. They may also write logs depending on logging configuration. status and diagnose do not open the log file, so they remain usable when that log destination is unwritable. “No deployment” means they do not write certificate outputs or invoke application deployment operations.

Run certone <command> --help for the options accepted by that command. Unsupported options and extra positional arguments are rejected.

Put options after the relevant subcommand: use certone run --config …, not certone --config … run. Put the service operation after service and the application command after exec's -- separator.

Use check for configuration problems, doctor --network for connectivity, status for deployment records, and logs for the actual failure reason.