Docs

CLI

@nixploy/cli — the same REST API from your terminal.

Install & login

npm i -g @nixploy/cli
nixploy auth login --url https://panel.example.com --api-key nxlp_...
nixploy doctor

Command groups

  • project — list / create
  • app — list / create / deploy / redeploy / logs
  • compose — list / create / deploy / logs / env / save / pull
  • template — list / one / deploy
  • db, env, tag, domain, server, deploy, gitops

Credentials live in ~/.nixploy/config.json (0600). Override with --url / --api-key or NIXPLOY_API_URL / NIXPLOY_API_KEY.

Also see the repository guides under docs/ · REST API reference

Docs menu