@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.
    • --workspace-id <id> Workspace to deploy to. Alternatively, set NOYA_WORKSPACE_ID.
    • --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.
    • -y, --yes Skip the preflight confirmation prompt.
• noya login
  • Stores a personal access token in the global Noya config.
  • Flags:
    • --token <token> Personal access token. Alternatively, set NOYA_TOKEN.
    • -f, --force Replace an existing token without confirmation.
• noya init [name]
  • Initializes an app using the supplied project name, or prompts when omitted.
• noya set [image transform options]
  • Sets theme.transform.image.url and/or workflow-format theme.transform.image.inputs while preserving other theme properties.
  • Uses appId from the nearest .noya/deploy.json by default.
  • Flags:
    • --theme.transform.image.url <url> Set the transform script URL.
    • --theme.transform.image.inputs <json> Set input definitions from one JSON array.
    • --app-id <id> Target a specific app instead of using deploy config.
    • --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.

Environment variables

• NOYA_TOKEN Personal access token for authenticated deploys.
• NOYA_WORKSPACE_ID Workspace to use for new sites.
• 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)
  • workspaceId: Workspace used when the site was created

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"
• Non-interactive deploy: noya deploy --workspace-id workspace_123 --token "$NOYA_TOKEN" --app --name "My App" --preflight --yes
• Non-interactive login: noya login --token "$NOYA_TOKEN" --force
• Configure an image transform: noya set --theme.transform.image.url "https://my-app.noya.io/imageTransform.js"
• Configure image transform inputs: noya set --theme.transform.image.inputs '[{"kind":"data","name":"width","required":true,"schema":{"type":"number","_kind":"Number","default":1200}}]'
• Dry run (no network/writes): noya deploy --dry-run
• Preflight confirmation: noya deploy --preflight