Publish dashboards from any repository without leaving your editor. Install the Dashtxtastic plugin for Claude Code, ask for a dashboard in plain words, and Claude picks the render mode, writes the markdown to that mode's spec, uploads it, and hands back a share link. Running it again on the same file updates the same dashboard and keeps the same link.

Prerequisites

  • A Dashtxtastic account on any plan. The Developer API is included on Free, which holds up to five projects; Pro and Pro + AI are unlimited.
  • An API key minted at /settings/developer. The plaintext is shown once; copy it to a password manager.
  • Claude Code installed and signed in.

Install the plugin

Run these two commands inside Claude Code:

/plugin marketplace add jsucupira/dashtxtastic-plugin
/plugin install dashtxtastic@dashtxtastic

The plugin source, including the full skill and a GitHub Action, lives at github.com/jsucupira/dashtxtastic-plugin.

Set your API key

Export the key in the shell you launch Claude Code from, and add the line to ~/.zshrc or ~/.bashrc so it survives new sessions.

export DTX_API_KEY="dtx_..."                       # required
export DTX_BASE_URL="https://dashtxtastic.com"     # optional, defaults to this

The plugin stops if DTX_API_KEY is not set. It never asks for the key inline and never echoes it in commands.

Try it

  • "Publish NEXT.md as a status dashboard and give me a share link."
  • "Turn docs/roadmap.md into a stages roadmap, locked with an access code."
  • "Update the dashboard with today's changes."

What the plugin does

  1. Reads the live render modes. GET /api/v1/render-modes returns the current authoring spec for every mode.
  2. Proposes a mode. It matches your content to a mode (table below) and asks you to confirm.
  3. Creates or reuses the project. A .dashtxtastic.json file at your repository root maps each source file to its dashboard, so a second run updates instead of duplicating. It holds ids and URLs only, so it is safe to commit.
  4. Writes the markdown to the chosen mode's spec.
  5. Publishes with one PUT; the render happens inline.
  6. Shares. It renews the existing public link, or creates one when none exists, and returns the /s/... URL.
Your content shape Mode
Plain narrative or status report prose
Section-as-tile grid tile_dashboard
Reference sheet, label catalog, glossary, lookup tables list_dashboard
Current state vs future state, transformation infographic_before_after
Multi-phase roadmap with work items and exit criteria infographic_stages
Themed track aggregator, status hub, parallel-paths layout project_hub

Dashtxtastic does not have a dedicated process-flow mode. For flow diagrams or parallel-paths layouts, the plugin maps to project_hub and re-shapes the content into themed track lists, with confirmation before writing.

Per-mode authoring tips

  • infographic_before_after uses Dashtxtastic-flavored markdown: [[chip]] bullets and **Lead.** body footer takeaways.
  • infographic_stages expects bold key/value meta lines (**Window:**, **Author:**, **Status:**), 3 to 5 **Label.** body guiding-constraint bullets, one ## Phase N: Name (window) per phase, and a ## Metrics and targets table. Appendices are optional; omit them if the doc has none.
  • project_hub wants 3 featured H3 cards plus a trailing ### Why this matters, then up to 4 themed track groups. Each track bullet is [Name](sibling.md), owner Name. Headline. for same-project links; use [Name](/view/<other-project-guid>) for cross-project links to other Dashtxtastic dashboards. Featured card bodies must be one or more short paragraphs separated by blank lines: bullet lists inside a featured H3 are stripped (the card renders with the title only), and markdown two-space line breaks inside a single paragraph are collapsed. For a multi-beat narrative inside one card, split each beat into its own paragraph with a bolded cue lead, e.g. **Where we are.** ... then blank line then **What we are missing.** .... Prefix a track bullet with a status marker to color-code it and draw a legend band at the foot of the hub: [at-risk] (amber), [blocked] (red), [decision] (purple), [new] (blue); no marker means on track (green).
  • list_dashboard renders a reference-document layout: navy header band, uppercase navy H2 section titles, navy-headered tables with alternating rows. Bold identifier-shaped tokens (no whitespace, like admin-config or CityOfMargate) are auto-styled as monospace blue label badges; multi-word bolds stay as ordinary bold.
  • Sibling links use relative paths in every render mode, not just project_hub. Inside any uploaded file, write [label](sibling.md) or [label](subdir/sibling.md) to link to another file in the same project. The renderer rewrites the .md to the published .html and keeps the click inside the preview iframe. Do not write [label](https://dashtxtastic.com/view/<projectId>/sibling.md) for same-project links; full URLs are only correct for cross-project links or off-platform documents.

Publish on every push with GitHub Actions

The same repository ships an Action that republishes a markdown file on every push and keeps the share URL stable. Add a DASHTXTASTIC_API_KEY repository secret, then:

- uses: jsucupira/dashtxtastic-plugin/publish-action@v0.1.0
  with:
    api-key: ${{ secrets.DASHTXTASTIC_API_KEY }}
    file: STATUS.md
    render-mode: tile_dashboard

The Action reuses the project whose name matches project-name (the repository name by default), and renews the existing share link instead of minting a new one. Its outputs are project-id and share-url.

Share links

The owner preview URLs (/view/<id> or /p/<id>/<file>.html) need your login. To send a dashboard to someone without an account, use the share link under /s/<slug>. It can be:

  • Password-protected. Ask for an access code; viewers see an unlock form on first visit. The code is hashed at rest and never returned, so send it separately from the link.
  • Scoped to one file. Share a single page without exposing the rest of the project.
  • Time-limited. Links last 30 days by default and can be extended without changing the URL.

Failure modes

HTTP Cause What the plugin does
401 Key missing or revoked Stops and tells you to mint a new key at /settings/developer
402 project_cap_reached Free plan already holds five projects Quotes the message; archive or delete a project, or upgrade to Pro
412 Tried to delete the main or last file Promotes another file via POST /files/set-main first
413 Markdown body over 1 MiB Splits the content across files
422 Renderer rejected the markdown shape Re-reads the mode's spec and rewrites
429 Rate limit exhausted (60 reads / 30 writes per minute per key) Waits; does not retry in a tight loop

Reference

  • API base: https://dashtxtastic.com/api/v1
  • OpenAPI: https://dashtxtastic.com/api/openapi/v1.json
  • API docs: https://dashtxtastic.com/api/docs/index.html
  • Mint keys: https://dashtxtastic.com/settings/developer
An unhandled error has occurred. Reload 🗙

Rejoining the server...

Rejoin failed... trying again in seconds.

Failed to rejoin.
Please retry or reload the page.

The session has been paused by the server.

Failed to resume the session.
Please retry or reload the page.