@zaks-io/agent-paste 0.0.0 → 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work, excluding
+          those notices that do not pertain to any part of the Derivative
+          Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and do
+          not modify the License. You may add Your own attribution notices
+          within Derivative Works that You distribute, alongside or as an
+          addendum to the NOTICE text from the Work, provided that such
+          additional attribution notices cannot be construed as modifying
+          the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 zaks-io
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,216 @@
+# @zaks-io/agent-paste
+
+Command-line interface for publishing shareable **Artifacts** to [Agent Paste](https://agent-paste.sh). Point it at a file or folder and it uploads the bytes, finalizes a revision, and prints a shareable URL. Built for agents and CI, usable by hand.
+
+The npm package is `@zaks-io/agent-paste`; the installed binary is `agent-paste`.
+If your agent host cannot run a CLI but can connect to remote MCP, use the
+hosted MCP server instead: [`https://mcp.agent-paste.sh`](https://mcp.agent-paste.sh).
+See [`docs/mcp.md`](../../docs/mcp.md).
+
+## Install
+
+### Standalone binary (no Node required)
+
+macOS and Linux:
+
+```sh
+curl -fsSL https://agent-paste.sh/install.sh | sh
+```
+
+Windows (PowerShell):
+
+```powershell
+irm https://agent-paste.sh/install.ps1 | iex
+```
+
+This downloads the prebuilt binary for your OS/arch, verifies it against the release `SHA256SUMS`, sets the exec bit, and installs to `~/.local/bin/agent-paste` (no sudo). On Windows it installs to `%LOCALAPPDATA%\agent-paste\bin` and updates your user `PATH`.
+
+Overrides (env vars): `AGENT_PASTE_VERSION` pins a release tag (e.g. `cli-v0.1.0`; default `latest`), `AGENT_PASTE_INSTALL_DIR` changes the install directory.
+
+The macOS binary is codesigned and notarized. Prefer manual verification? Download the asset and `SHA256SUMS` from the [releases page](https://github.com/zaks-io/agent-paste/releases) and run `shasum -a 256 -c SHA256SUMS`, then `chmod +x` the binary yourself.
+
+### npm (Node.js 24+)
+
+No install required:
+
+```sh
+npx @zaks-io/agent-paste publish <path>
+```
+
+For repeated use:
+
+```sh
+npm install -g @zaks-io/agent-paste
+```
+
+## Authenticate
+
+For interactive use, sign in through your browser. `login` runs a loopback PKCE flow, mints a scoped **API Key**, and stores it in the OS keyring (macOS Keychain, Windows Credential Manager, or Linux Secret Service). If no keyring is available, it falls back to `~/.config/agent-paste/credentials.json` at mode `0600` and prints a warning.
+
+```sh
+agent-paste login
+agent-paste logout
+```
+
+The minted key is capped at `publish` and `read`, expires after 90 days, and never grants admin.
+
+For CI and headless agents, set `AGENT_PASTE_API_KEY` instead:
+
+```sh
+export AGENT_PASTE_API_KEY=ap_pk_...
+```
+
+`AGENT_PASTE_API_KEY` takes precedence over a stored login credential; when both are present the CLI prints a one-line note to stderr naming which it used. The CLI never accepts secrets as flags. API Keys encode their **Workspace**.
+
+## Publish
+
+A folder:
+
+```sh
+npx @zaks-io/agent-paste publish ./report
+```
+
+A single file:
+
+```sh
+npx @zaks-io/agent-paste publish ./report.html
+```
+
+A new revision of an existing Artifact:
+
+```sh
+npx @zaks-io/agent-paste publish ./report --artifact-id art_01H...
+```
+
+Artifact lifetime is server-side Workspace/Plan policy. The CLI does not accept
+a retention flag.
+
+## Publish without signing in
+
+For agents with no human auth, `--ephemeral` skips login entirely. The CLI self-provisions a short-lived **Workspace** and key, publishes, and prints a one-time **Claim Token** as a claim link.
+
+```sh
+npx @zaks-io/agent-paste publish ./report --ephemeral
+```
+
+`--ephemeral` ignores `AGENT_PASTE_API_KEY` and any stored login credential (it prints a one-line note to stderr when it does). The Artifact lives for at most **24 hours** (the ephemeral TTL ceiling) and then auto-deletes. To keep it, a signed-in human opens the claim link to reparent the Artifact into their Personal Workspace.
+
+The Claim Token rides the URL **hash** only (`/claim#<token>`): never the query string, and never the `view_url` or `agent_view_url`. The claim link points at `AGENT_PASTE_WEB_URL` (default `https://app.agent-paste.sh`).
+
+## Commands
+
+| Command                       | Purpose                                                                          |
+| ----------------------------- | -------------------------------------------------------------------------------- |
+| `agent-paste login`           | Mint a publish/read API key via browser loopback login.                          |
+| `agent-paste logout`          | Revoke the stored API key when possible, then remove the local credential.       |
+| `agent-paste whoami`          | Show the resolved **Workspace**, actor, and granted scopes.                      |
+| `agent-paste publish <path>`  | Walk a local file or directory, upload bytes, finalize, and print the result.    |
+| `agent-paste version`         | Print the CLI version baked in at build time.                                    |
+| `agent-paste upgrade [<tag>]` | Self-update a standalone binary install: download, verify, and replace in place. |
+
+## Flags
+
+| Flag                   | Purpose                                                                                                 |
+| ---------------------- | ------------------------------------------------------------------------------------------------------- |
+| `--artifact-id <id>`   | Publish a new revision of an existing Artifact instead of creating a new one.                           |
+| `--title <text>`       | Set the title. Default: path basename.                                                                  |
+| `--entrypoint <path>`  | Override the inferred entrypoint. Must be a file inside the upload.                                     |
+| `--render-mode <mode>` | Override the inferred render mode: `html`, `markdown`, `text`, `image`, `audio`, `video`.               |
+| `--ephemeral`          | Publish with no login or key. Self-provisions a short-lived Workspace and prints a one-time claim link. |
+| `--json`               | Emit the result as JSON on stdout. Stdout becomes pure JSON.                                            |
+| `--quiet`              | Suppress human-readable stdout output.                                                                  |
+
+## Output
+
+Default human-readable output:
+
+```text
+Published artifact art_01H... revision rev_01H...
+
+  Title:      report
+  View:       https://usercontent.agent-paste.sh/v/...
+  Agent View: https://api.agent-paste.sh/v1/public/agent-view/...
+  Expires:    2026-06-20T00:00:00.000Z
+```
+
+With `--json`, stdout is exactly the publish result:
+
+```json
+{
+  "artifact_id": "art_01H...",
+  "revision_id": "rev_01H...",
+  "title": "report",
+  "view_url": "https://usercontent.agent-paste.sh/v/...",
+  "agent_view_url": "https://api.agent-paste.sh/v1/public/agent-view/...",
+  "expires_at": "2026-06-20T00:00:00.000Z",
+  "bundle": {
+    "status": "pending",
+    "retry_after_seconds": 5
+  }
+}
+```
+
+`view_url` is served from the isolated content origin (`usercontent.agent-paste.sh`);
+`agent_view_url` is the Agent View JSON on the API origin. `bundle` reports
+whether the revision archive is pending, ready, failed, or disabled.
+
+With `--ephemeral`, the human-readable output appends the claim link:
+
+```text
+Open the claim link in a browser while signed in. The token lives in the URL hash only (never the query string).
+  Claim:      https://app.agent-paste.sh/claim#ap_ct_...
+```
+
+With `--json` and `--ephemeral`, the result also carries `claim_token`, `claim_url`, `workspace_id`, `api_key_id`, and `claim_token_id`.
+
+## Inference
+
+- **Entrypoint** for a folder is the first match of `index.html`, `index.md`, `README.md`, or the single file if the folder contains exactly one. Otherwise publish fails; pass `--entrypoint`.
+- **Render mode** is inferred from the entrypoint extension. Override with `--render-mode`.
+
+## Excluded by default
+
+The CLI excludes these from any folder upload and prints the excluded set to stderr:
+
+- `.git/`
+- `.DS_Store`
+- `node_modules/`
+- `.env`, `.env.*`
+
+The exclusion list is not configurable. If you need one of these in the upload, build a folder without it.
+
+## Idempotency and retries
+
+The CLI generates an **idempotency key** per `publish` invocation and reuses it across automatic retries, so transient network failures cannot produce duplicate Artifacts or Revisions. Transient failures (network errors, 5xx, 429 with `Retry-After`) are retried up to 3 times with 1s/2s/4s backoff. Non-transient failures (4xx) exit immediately. An expired upload session exits cleanly; re-run `publish` to start over.
+
+## Errors
+
+Exit `0` for success, `1` for any failure. Errors are plain text on stderr,
+including when `--json` is set:
+
+```text
+agent-paste: not_authenticated: Set AGENT_PASTE_API_KEY or pass an auth provider.
+```
+
+The middle field is the stable error code. The message is human-readable.
+
+## Configuration
+
+| Variable                      | Purpose                                                                                                             |
+| ----------------------------- | ------------------------------------------------------------------------------------------------------------------- |
+| `AGENT_PASTE_API_KEY`         | API key for CI and headless use. Takes precedence over stored login.                                                |
+| `AGENT_PASTE_API_URL`         | Override the API base URL. Defaults to `https://api.agent-paste.sh`.                                                |
+| `AGENT_PASTE_WEB_URL`         | Override the web app base URL used to build the `--ephemeral` claim link. Defaults to `https://app.agent-paste.sh`. |
+| `AGENT_PASTE_NO_UPDATE_CHECK` | Set to any value to disable the background update check entirely.                                                   |
+
+## Staying up to date
+
+After a real command (not `help`/`version`), the CLI checks at most once per 24h whether a newer version has been published and prints a single hint to **stderr**. It is silent in CI, with `--json`, with `--quiet`, on a non-TTY, and when `AGENT_PASTE_NO_UPDATE_CHECK` is set; a network failure is swallowed and never affects the command's result or exit code. The hint is tailored to how you installed it:
+
+- **Standalone binary** → `agent-paste upgrade`. This downloads the matching release asset from GitHub, verifies it against `SHA256SUMS`, and atomically replaces the running binary in place. Pin a specific release with `agent-paste upgrade cli-v1.2.3`. If the install directory is not writable by your user (a `sudo`-installed binary), the verified download is left staged and the CLI prints the exact `sudo mv` to finish.
+- **`npm i -g`** → `npm i -g @zaks-io/agent-paste@latest`.
+- **`npx`** → nothing; `npx` already runs the latest published version.
+
+## When not to use the CLI
+
+The CLI runs either as a standalone binary (the installer above, no Node) or via Node/`npx`. For server-to-server callers and environments where neither fits (Python or Go agents, sandboxes without a shell or filesystem), call the REST API directly at `https://api.agent-paste.sh/v1`.