- commit
- 04909bad027648f6db6ab038ae9ef50a138e83de
- parent
- cdcb2154b8e80e903fdf1c04ff9a6646437fb6df
- author
- Dami <dami.etoile@gmail.com>
| M | .gitignore | 2 | +- |
| M | agent/ | 40 | ++++++++++++++++-------------- |
@@ -6,4 +6,4 @@ worker/wrangler.local.jsonc
66 .DS_Store77 tmp/88 __pycache__/9-.nzip-*-plan/9+.nzip-*/@@ -24,18 +24,20 @@ produced it. Diagnose the local installation before guessing about unavailable a
2424 nzip auth --server <url> --token <token>2525 ```2626 27- Omit `--token` when an interactive prompt is safer. The prompt requires a TTY: in a28- non-interactive run, omitting `--token` fails instead of prompting, so ask the user to run29- `nzip auth` themselves. Never print, commit, or invent the token.27+ When `--server` is omitted, the prompt defaults to `NZIP_SERVER` (or `NZIP_DOMAIN`, expanded to28+ `https://<domain>`); check those variables before asking the user for a server. No environment29+ variable supplies the token. Omit `--token` when an interactive prompt is safer. The prompt30+ requires a TTY: in a non-interactive run, omitting `--token` fails instead of prompting, so ask31+ the user to run `nzip auth` themselves. Never print, commit, or invent the token.3032 3133 5. Ensure the repository `.gitignore` contains this exact rule:3234 3335 ```gitignore34- .nzip-*-plan/36+ .nzip-*/3537 ```3638 3739 Add the rule without replacing existing ignore entries. Put generated sites at the repository38- root using a descriptive name such as `.nzip-auth-plan/` or `.nzip-api-design-plan/`. Keep the40+ root using a descriptive name such as `.nzip-auth-plan/` or `.nzip-weekly-report/`. Keep the3941 directory after publishing so later revisions retain the originating repository context, but do4042 not commit it.4143 @@ -50,19 +52,18 @@ Run checks in this order and stop at the first failure that needs user input:
5052 5153 Use the JSON `error` and `hint` fields as the primary diagnosis. Re-run `nzip auth` for missing or5254 rejected credentials, correct the configured server for reachability failures, and ask the user to53-choose a vault when no safe destination is evident. Respect `allowVaults`; never bypass it with a54-raw address. Ask to use the required network or filesystem permissions when a sandbox blocks a55-check instead of reporting nzip as broken.55+choose a vault when no safe destination is evident. Ask to use the required network or filesystem56+permissions when a sandbox blocks a check instead of reporting nzip as broken.5657 5758 ## Publish an artifact5859 59-1. Create a complete site inside `.nzip-<purpose>-plan/` at the repository root. Use `index.html`60- as its entry point and keep any related assets inside the same directory.60+1. Create a complete site inside `.nzip-<purpose>/` at the repository root. Use `index.html` as its61+ entry point and keep any related assets inside the same directory.6162 2. Validate the artifact locally in proportion to its complexity.6263 3. Publish with an explicit low TTL:6364 6465 ```sh65- nzip push .nzip-<purpose>-plan/ --ttl 1d66+ nzip push .nzip-<purpose>/ --ttl 1d6667 ```6768 6869 Use `1d` for plans, designs, review pages, and other disposable agent artifacts unless the user@@ -74,7 +75,7 @@ check instead of reporting nzip as broken.
7475 `nzip vault ls --json`:7576 7677 ```sh77- nzip push .nzip-<purpose>-plan/ <vault>:<alias> --ttl 1d78+ nzip push .nzip-<purpose>/ <vault>:<alias> --ttl 1d7879 ```7980 8081 5. Return the canonical URL and expiry. If the user requested a review boundary or asked for only@@ -87,7 +88,8 @@ Prefer `--json` when consuming command output programmatically.
8788 - Inspect readiness: `nzip status --json`8889 - List destinations: `nzip vault ls --json`8990 - Register a vault: `nzip vault add <name> [--slot N] [--description TEXT]`90-- Rename or describe a vault: `nzip vault update <name> [--name NEW_NAME] [--description TEXT | --no-description]`91+- Rename or describe a vault:92+ `nzip vault update <name> [--name NEW_NAME] [--description TEXT | --no-description]`9193 - Set the default vault: `nzip vault default <name>`9294 - List sites: `nzip ls [vault] --json`9395 - Inspect a site: `nzip site <target> --json`@@ -104,19 +106,19 @@ Use password protection when the content or user requires it; `nzip push` accept
104106 `--password <pw> | --no-password` flags to set it at publish time. Vault descriptions appear in105107 `vault ls` and `status`; use them to pick the right destination, and pass `--no-description` to106108 clear one. A vault rename updates the invoking client's default vault, allow-list, and local push107-records, but other clients keep the old name; renaming to a name outside `allowVaults` is refused. Treat `revert`, vault renames, password changes, TTL changes, and108-deletion as state changes; do not perform them while merely diagnosing. Never infer deletion109-confirmation.109+records, but other clients keep the old name; renaming to a name outside `allowVaults` is refused.110+Treat `revert`, vault renames, password changes, TTL changes, and deletion as state changes; do not111+perform them while merely diagnosing. Never infer deletion confirmation.110112 111113 ## Sane defaults112114 113-- Keep generated HTML in `.nzip-<purpose>-plan/`, not a system temp directory or a tracked source115+- Keep generated HTML in `.nzip-<purpose>/`, not a system temp directory or a tracked source114116 directory, unless requested.115-- Ignore all such directories with `.nzip-*-plan/`.117+- Ignore all such directories with `.nzip-*/`.116118 - Publish disposable plans and designs with `--ttl 1d`.117119 - Prefer finite TTLs; use `forever` only when explicitly requested.118120 - Prefer descriptive aliases and an explicit vault when identity or audience matters.119-- Preserve the local plan directory for iteration and `nzip where`; do not commit it.121+- Preserve the local artifact directory for iteration and `nzip where`; do not commit it.120122 - Use complete, self-contained HTML and relative asset paths.121123 - Use read-only status, list, and inspect operations before mutations when destination state is122124 uncertain.