What do you want to do?
4 use cases
-
Put a live metric chart beside its explanation
Build one page where a Prometheus or SQL chart sits next to the text that explains it.
- Oxynote
- Software and DevOps
- Intermediate
View prompt
Using the oxynote/oxynote repo running at <oxynote-url>, create a page titled <page-title> with a Live Metrics block that runs <prometheus-or-sql-query> and an explanation paragraph under it. Expected output: the page URL and a list of the blocks on it. Verify that the chart renders with live data and that the explanation is on the same page.
-
Route runbook edits through a draft and approval
Make a page reviewable so every edit becomes a draft that a reviewer approves before it merges.
- Oxynote
- Software and DevOps
- Intermediate
View prompt
Using the oxynote/oxynote repo at <oxynote-url>, change the page <page-title> so that a draft holds the edit to <change-description>. Expected output: the draft link and a summary of the block-level diff. Verify that main is unchanged until the draft is approved.
-
Let Claude Code or Codex edit runbooks over MCP
Connect a coding agent to Oxynote so it can read and update pages through the same tools.
- Oxynote
- Claude Code
- Codex
- Software and DevOps
- Advanced
View prompt
Using the oxynote/oxynote MCP server at <oxynote-url>, update the page <page-title> to reflect <change-description>. Expected output: the draft link and a short list of the blocks changed. Verify that the change appears as a draft and that main is untouched.
-
Get reminded when a runbook's source changes
Attach freshness hooks to a page so its maintainers hear about changes to the files or images it depends on.
- Oxynote
- Software and DevOps
- Intermediate
View prompt
Using the oxynote/oxynote repo at <oxynote-url>, add a freshness hook to the page <page-title> that tracks <github-file-or-image>. Expected output: the hook name and its target. Verify that the page shows the tracked dependency and that the maintainers are listed.
How to use Oxynote
- Check you have what it needs: Docker installed, with port 8080 free on the host; A Prometheus server or a PostgreSQL, MySQL or MariaDB database to query for live metric blocks; The default login from the README ([email protected]) changed before any real data goes in.
- Open oxynote/oxynote on GitHub and read the README and license.
- Run
docker run -d --name oxynote -p 8080:8080 -v oxynote_data:/oxynote/data ghcr.io/oxynote/oxynote:latest(join the lines into one command). (inferred, check the README) - Open http://localhost:8080 and log in with
[email protected]andoxynote-admin-1234, then change that password. - Create a new page and insert a Live Metrics block. (inferred, check the README)
- Add a Prometheus or SQL query to the block and choose time series, bar chart or gauge. (inferred, check the README)
These steps come from our top use case, Put a live metric chart beside its explanation, which also has a copy-paste agent prompt.
Every Monday: the 5 hottest repos and exactly how to use them. Free, one email a week, unsubscribe anytime.
Get them freeOxynote alternatives · Best AI repos for Software and DevOps
About this repo
- Who it is forTech people and on-call engineers who run their own systems and want charts, runbooks and API docs on one reviewable page that they and their agents can both read.
- Why it is hot
- LanguageGo
- Sourcegithub.com/oxynote/oxynote · Back to Hot repos
Requirements
- Docker installed, with port 8080 free on the host
- A Prometheus server or a PostgreSQL, MySQL or MariaDB database to query for live metric blocks
- The default login from the README ([email protected]) changed before any real data goes in
- For agent access: Claude Code or Codex installed, able to use MCP over OAuth
Add this badge to your README
Maintain Oxynote? Show readers where to find these use cases.
Markdown
[](https://dedupedai.com/use-cases/oxynote-oxynote/?utm_source=github&utm_medium=badge&utm_campaign=oxynote-oxynote)
HTML
<a href="https://dedupedai.com/use-cases/oxynote-oxynote/?utm_source=github&utm_medium=badge&utm_campaign=oxynote-oxynote"><img src="https://dedupedai.com/badge/oxynote/oxynote.svg" alt="Use cases on Deduped" height="20"></a>
A static image, no tracking script. About the badge
Questions about Oxynote
What is Oxynote?
Oxynote is a self-hosted open-source technical wiki that puts live metric charts, Stripe-style API docs and reviewable drafts next to the explanations for the systems they describe. It is an open-source project on GitHub: https://github.com/oxynote/oxynote.
Who is Oxynote for?
Tech people and on-call engineers who run their own systems and want charts, runbooks and API docs on one reviewable page that they and their agents can both read.
What can I do with Oxynote?
4 use cases so far, for example: Put a live metric chart beside its explanation; Route runbook edits through a draft and approval; Let Claude Code or Codex edit runbooks over MCP. Each has steps and a copy-paste agent prompt.
What do I need to run Oxynote?
Docker installed, with port 8080 free on the host; A Prometheus server or a PostgreSQL, MySQL or MariaDB database to query for live metric blocks; The default login from the README ([email protected]) changed before any real data goes in; For agent access: Claude Code or Codex installed, able to use MCP over OAuth.
What are alternatives to Oxynote?
Other hot AI repos in Software and DevOps: Omarchy Local AI, Hermes Plan Mode, Agent 2, Agnes Harness, Skills.
Is Oxynote safe to run?
Deduped does not own, audit or vouch for it. Read the README and license, run it on your own systems first and review every command before you run it.