@nolgia/cli 0.2.6 → 0.2.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +51 -39
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,8 +1,6 @@
1
1
  # @nolgia/cli
2
2
 
3
- Command line interface for the [Nolgia](https://nolgia.ai) generative media platform: images, video (including native multi-shot sequences), and audio from your terminal or from AI agents
4
-
5
- This package downloads the prebuilt `nolgia` binary for your platform during postinstall (macOS universal, Linux x86_64, Windows x86_64) and exposes it as `nolgia` on your PATH. The binary is the same one attached to each [GitHub release](https://github.com/nolgiainc/nolgia-cli/releases)
3
+ The npm wrapper for the [Nolgia](https://nolgia.ai) command-line client. It downloads a platform binary during postinstall and exposes it as `nolgia`; the small Node launcher forwards each invocation to that Rust binary.
6
4
 
7
5
  ## Install
8
6
 
@@ -10,62 +8,76 @@ This package downloads the prebuilt `nolgia` binary for your platform during pos
10
8
  npm install -g @nolgia/cli
11
9
  ```
12
10
 
13
- Other install paths (Homebrew, cargo, curl installer, raw binaries) are covered in the [repository README](https://github.com/nolgiainc/nolgia-cli#installation)
11
+ The package requires Node 18 or newer and supports macOS universal, Linux x86_64, and Windows x86_64. Postinstall downloads the release asset matching the package version from [GitHub Releases](https://github.com/nolgiainc/nolgia-cli/releases), and the Node launcher forwards each command to that binary. If a package version has no matching release asset for your platform, install from [Cargo](https://github.com/nolgiainc/nolgia-cli#cargo-or-a-prebuilt-binary), the shell installer, Homebrew, or a compatible prebuilt release instead. Review registry and release provenance according to your environment's supply-chain policy before enabling postinstall downloads.
12
+
13
+ > **Release boundary.** This README is published with the npm package. The repository `main` branch can contain unreleased source changes, while `npm install` runs the tagged binary selected by the package version. Check `nolgia --version` and `nolgia --help`; do not assume a source-only command or flag is present in an older npm install.
14
14
 
15
15
  ## Quick start
16
16
 
17
17
  ```bash
18
- nolgia auth login # device-code sign-in via your browser
19
- nolgia models list # live model catalog with capabilities and credit pricing
18
+ nolgia auth login
19
+ nolgia models list
20
+ nolgia gen image --prompt "a futuristic city at sunset" --out city.png
21
+ nolgia gen video --model <VIDEO_MODEL_ID> --prompt "a slow dolly through a neon atelier" --out clip.mp4
22
+ nolgia gen audio --model <AUDIO_MODEL_ID> --prompt "rain on a window" --out rain.mp3
23
+ ```
20
24
 
21
- nolgia gen image --model flux-pro --prompt "A futuristic city at sunset" --out city.png
25
+ The live catalog is the source of truth for model IDs, capabilities, durations, and credit pricing:
22
26
 
23
- nolgia gen video --model veo-3.1 --prompt "A slow dolly through a neon atelier" \
24
- --duration-seconds 8 --out clip.mp4
27
+ ```bash
28
+ nolgia models get <MODEL_ID>
29
+ nolgia gen video --model <VIDEO_MODEL_ID> --prompt "..." --cost-only
30
+ ```
25
31
 
26
- nolgia gen video --model fal-ai/bytedance/seedance/v2/pro/text-to-video \
27
- --prompt "Gritty 35mm film look" \
28
- --shot "8:WIDE SHOT. Rural highway, a single car heading south|engine, wind" \
29
- --shot "4:MCU. The driver glances at the dead radio|AM static cuts out" \
30
- --generate-audio true --out sequence.mp4
32
+ ## What the binary can do
31
33
 
32
- nolgia gen audio --model fal-ai/elevenlabs/tts/eleven-v3 --prompt "Welcome to Nolgia" --out hello.mp3
33
- ```
34
+ - `gen image`, `gen video`, and `gen audio` submit jobs and can download a completed asset with `--out`.
35
+ - Video supports model-dependent image-to-video (`--input <IMAGE_FILE|IMAGE_ASSET_UUID>`), repeated `--shot "SECONDS:PROMPT|AUDIO DIRECTION"` segments, `--generate-audio`, and live `--cost-only` estimates. Do not treat `--input` as an arbitrary asset reference: the selected model must accept image input.
36
+ - `assets`, `characters`, and `projects` organize generated media. `assets upload` accepts PNG, JPEG, or WebP files. Newer source/release versions may add more asset verbs; confirm with `nolgia assets --help`.
37
+ - `models list|get` exposes the current catalog. `billing credits`, `billing subscription`, and `billing portal` expose account billing operations. `account me|usage` reports identity and visible job/asset counts.
38
+ - `pat create|list|revoke` manages personal access tokens. `completion <SHELL>` emits shell completion code.
34
39
 
35
- ## Highlights
40
+ For the full version-specific command index, run `nolgia --help`; for flags, run `nolgia <COMMAND> --help`. Marketplace `ability` commands, asset-frame extraction, and newer quality/reference options are source/release-version dependent and should be confirmed with that help output. Replace `<PLACEHOLDER>` values before running examples.
36
41
 
37
- `nolgia gen video` supports text-to-video and image-to-video; pass `--input` with a local file or an asset UUID. Models with native image input like Veo and Omni Flash take it directly, while Kling and Seedance switch to their image-to-video variants. Multi-shot sequences are first class through repeated `--shot SECONDS:PROMPT|AUDIO` flags; the platform composes the cut natively
42
+ ## Authentication and output
38
43
 
39
- Costs are transparent: `nolgia gen video --cost-only` prints the credit estimate from the live catalog before you spend anything, and `nolgia models list` shows per-model pricing and capabilities
44
+ Interactive login uses a browser device-code flow:
40
45
 
41
- Every command takes `--json` for machine-readable output, which is how agent pipelines drive the CLI. Authentication accepts a browser device-code flow (`nolgia auth login`) or a personal access token via `--token` / `NOLGIA_TOKEN`
46
+ ```bash
47
+ nolgia auth login
48
+ nolgia auth status
49
+ nolgia auth token
50
+ ```
42
51
 
43
- ## Command overview
52
+ For CI or agents, prefer a personal access token in `NOLGIA_TOKEN` or a secret manager. `--token` is also accepted, but command-line arguments can appear in shell history and process listings. The npm package is release-versioned: the `0.2.6` package metadata in this checkout uses its release's keyring-based login behavior; the file-backed `NOLGIA_TOKEN_STORE` and XDG token path described in the source/main README apply only to a release that contains that newer auth implementation. Confirm the installed binary's behavior with `nolgia --version` and its help/release notes.
44
53
 
45
- | Command | Purpose |
46
- |---|---|
47
- | `nolgia auth login` / `status` / `logout` | Device-code sign-in, token storage in the system keyring |
48
- | `nolgia gen image` / `video` / `audio` | Submit generations, wait, and download results |
49
- | `nolgia status` / `wait` | Inspect or block on a job |
50
- | `nolgia assets list` / `get` / `upload` / `delete` / `tag` | Manage generated and uploaded assets, including tags |
51
- | `nolgia characters list` / `get` / `create` / `update` / `delete` | Reusable characters with reference images |
52
- | `nolgia projects list` / `get` / `create` / `update` / `delete` / `add-assets` / `remove-asset` | Group assets into projects |
53
- | `nolgia models list` / `get` | Live model catalog, capabilities, credit pricing |
54
- | `nolgia account` / `billing` | Usage, credits, and billing portal links |
55
- | `nolgia pat create` / `list` / `revoke` | Personal access tokens for API use |
56
- | `nolgia skills list` / `show` / `install` | Bundled skills for Claude Code and other agents |
57
- | `nolgia completion <shell>` | Shell completions |
54
+ `--json` is a global flag for commands that implement structured output; it is not a universal output contract. Generation with `--no-wait` prints a JSON job object, while `gen video --cost-only`, `auth token`, `completion`, and `skills show` remain text. `auth login` and `auth status`/`whoami` also print human text around any JSON response. A script can capture a job UUID and then wait for it:
55
+
56
+ ```bash
57
+ job_uuid=$(nolgia gen video --prompt "..." --no-wait | jq -r .job_id)
58
+ nolgia wait "$job_uuid" --json | jq .asset.signed_url
59
+ ```
60
+
61
+ Treat any signed URL returned by the CLI as a temporary bearer capability; avoid writing it to persistent CI logs or telemetry.
58
62
 
59
63
  ## Environment
60
64
 
61
65
  | Variable | Effect |
62
66
  |---|---|
63
- | `NOLGIA_TOKEN` | PAT (`nol_...`) or JWT used instead of the keyring |
64
- | `NOLGIA_API_URL` | Override the API base URL |
65
- | `NOLGIA_NO_UPDATE_CHECK` | Disable the once-daily update hint |
66
- | `NOLGIA_SURFACE` | Self-identify agent traffic |
67
+ | `NOLGIA_TOKEN` | PAT or JWT used when `--token` is not supplied |
68
+ | `NOLGIA_API_URL` | Override the API base URL (the client appends `/v1`) |
69
+ | `NOLGIA_TOKEN_STORE` | Supported only by releases containing the file-token implementation; older npm binaries use their release's auth store |
70
+ | `NOLGIA_NO_UPDATE_CHECK` | Disable the once-per-day release hint |
71
+ | `NOLGIA_SURFACE` | Override the `X-Nolgia-Surface` request value |
72
+ | `XDG_CONFIG_HOME` | Parent directory for install metadata; token location is release-version dependent |
73
+ | `XDG_STATE_HOME` | Parent directory for the update-check cache |
74
+ | `HERMES_HOME` | Parent of the Hermes `skills` directory when supported by the installed binary |
75
+
76
+ The update hint is cached locally, refreshed at most once per day, and suppressed for JSON, CI, non-interactive, and any non-empty `NOLGIA_SURFACE`. Use `NOLGIA_NO_UPDATE_CHECK=1` for a quiet script.
77
+
78
+ ## Other install paths and development
67
79
 
68
- Full documentation, the OpenAPI-generated client, and the development guide live in the [repository](https://github.com/nolgiainc/nolgia-cli). The platform itself is documented at [nolgia.ai](https://nolgia.ai)
80
+ The root [repository README](https://github.com/nolgiainc/nolgia-cli#installation) covers Homebrew, Cargo, the shell installer, prebuilt binaries, command semantics, and the development checks. The client API shapes are generated from the vendored [OpenAPI snapshot](https://github.com/nolgiainc/nolgia-cli/blob/main/crates/client/openapi.yaml); source builds use it by default.
69
81
 
70
82
  ## License
71
83
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nolgia/cli",
3
- "version": "0.2.6",
3
+ "version": "0.2.8",
4
4
  "description": "Nolgia CLI: generate images, video, and audio on the Nolgia platform",
5
5
  "bin": {
6
6
  "nolgia": "bin/nolgia.js"