Skip to main content
The Plannotator OSS sharing flow is deprecated and remains available for compatibility. No retirement date has been announced. Workspaces is the hosted path for new team-sharing workflows. See Workspaces Help for current sharing behavior. For the OSS flow, send a review link, let another person annotate it, then import the link they return into your local session.
  1. Open the header menu and select Copy Share Link, or open Export and choose Share.
  2. Copy the generated URL.
  3. Send the exact URL to the reviewer.
For a typical Markdown review, Plannotator compresses the document and annotations into the URL fragment, which is the part after #. Browsers do not include a URL fragment in the HTTP request to the share portal. The portal serves the application, then the recipient’s browser decodes the payload locally. The document and annotations are not uploaded to the paste service in this flow. The hosted share portal and its infrastructure still receive the normal request for the page and can process request metadata such as an IP address and user agent. The fragment keeps the review payload out of that request. The portal also performs Plannotator’s automatic GitHub release check when it loads. That request does not include the shared review payload. See Privacy and data flow.
Anyone with the complete URL can read the review. Treat the link as the credential and send it only through an appropriate channel.

​
Import returned annotations

Ask the reviewer to add annotations and copy their updated share link. In your original Plannotator session:
  1. Open the header menu.
  2. Select Import Review.
  3. Paste the returned URL.
Plannotator adds the imported annotations to the current review. Check them, add your own feedback if needed, then send the combined result to the agent.

​
Large sessions and HTML

Long URLs can be truncated by messaging tools. When a Markdown link exceeds about 2 KB, Export > Share offers Create short link. Raw HTML sharing always requires this short-link path. Short links involve the paste backend:
  1. Plannotator compresses the review payload.
  2. Your browser encrypts it with AES-256-GCM.
  3. The paste service stores only ciphertext.
  4. The decryption key stays in the URL fragment and is not sent to the service.
  5. The recipient’s browser downloads the ciphertext and decrypts it locally.
The short URL path contains the paste ID, so the share portal and paste service are involved in serving it even though they do not receive the decryption key. The default Plannotator paste service deletes entries after seven days. A self-run paste service can set its own retention period. For Markdown in the Export modal, creating a short link is explicit and upload starts only after you select Create short link. Raw HTML has different entry points because it cannot use the hash-only path:
  • In a local raw-HTML session, the header’s Copy Share Link action or a configured Approve or Send Feedback callback action can create and upload the encrypted short link immediately.
  • In a remote raw-HTML session, the compiled CLI creates the encrypted short link automatically when the session starts so another machine can open the HTML. Pi serves the HTML through the forwarded temporary session and does not upload it automatically at startup. A reviewer can still create a short link explicitly in the UI.
A share-link creator can configure an HTTP or HTTPS callback endpoint and include a token. When the recipient chooses Approve or Send Feedback, the browser posts the action, token, and annotated share URL to that endpoint. For an encrypted short link, annotated_url can contain the complete URL, including its fragment decryption key. Treat the link creator and callback endpoint as trusted with the shared content and key. Prefer HTTPS so the callback is encrypted in transit.

​
Markdown image limitation

Markdown share payloads preserve Markdown image references and attachment paths, not the bytes of local or relative images. A recipient may not see an image that exists only on your computer. Rendered HTML uses a separate portable-copy step that inlines eligible local assets before encryption. Portable Markdown images are a current limitation of the deprecated OSS sharing flow.

​
Use your own share services

The Plannotator repository includes the static share portal, a Bun paste service with filesystem storage, and a Cloudflare Worker target with KV storage. Self-host Plannotator OSS explains which pieces you need, how to deploy and connect them, and which security and retention controls remain your responsibility.

​
Disable sharing

Set the environment variable:
Or add this to <data-directory>/config.json:
For the compiled CLI, Pi, and integrations that use Plannotator’s shared configuration resolver, the environment variable takes precedence over config.json. OpenCode checks an explicit OpenCode share setting first. When sharing is disabled, Plannotator hides share and import actions. See Privacy and data flow for the other automatic and optional network requests made by Plannotator OSS. Last verified on August 10, 2026, using Plannotator product commit f8951cd. Maintained by the Plannotator project.
Last modified on August 10, 2026