@noya-app/cli

Noya CLI for deploying static sites to Noya and optionally creating an app pointing to the deployed site.

Install

• Global: npm i -g @noya-app/cli
• Ad‑hoc: npx @noya-app/cli deploy

Command

• noya deploy [dir]
  • Deploys a static folder to Noya. If no dir is provided, it looks for dist or out.
  • Flags:
    • --app Also create an app (tool) that points to the deployed URL.
    • --name <name> Name to use when --app is passed (otherwise prompted).
    • --token <token> Personal access token. Alternatively, set NOYA_TOKEN.
    • --api <url> API base URL. Defaults to https://www.noya.io/api or NOYA_API_URL.
    • --dry-run Show what would happen without making any network calls or writes.
    • --preflight Show discovered config (API, paths, files, siteId) and ask to confirm before deploying.

Environment variables

• NOYA_TOKEN Personal access token for authenticated deploys.
• NOYA_API_URL Override API base URL (e.g. https://staging.noya.io/api).

Config file

• After a successful deploy (non–dry‑run), the CLI writes .noya/deploy.json in your project root so subsequent deploys go to the same site.
• Fields:
  • siteId: Site to deploy to on subsequent runs
  • subdomain: Subdomain used for pretty URLs (if available)
  • url: Resolved URL to the site
  • deployDir: The relative folder that was deployed
  • appId: The created app’s id (when --app is used)

Examples

• First deploy from default folder: noya deploy
• Explicit folder: noya deploy ./out
• With token env: NOYA_TOKEN=… noya deploy
• Also create an app: noya deploy --app --name "My App"
• Dry run (no network/writes): noya deploy --dry-run
• Preflight confirmation: noya deploy --preflight