OpenParable
Skip to content
← Back to skills

Omm Push

Apps & Automation
omm-push

Omm Push is an Agent Skill for apps & automation published in the oh-my-mermaid/oh-my-mermaid repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Push architecture docs to oh-my-mermaid cloud. Handles login, link, and push workflow with error guidance. Use when the user says "omm push", "push to cloud", "deploy architecture", or "share architecture".

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/oh-my-mermaid/oh-my-mermaid/blob/HEAD/skills/omm-push/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/omm-push, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

omm-push — Cloud Push Workflow

Purpose

Automate the full workflow of pushing .omm/ architecture docs to the oh-my-mermaid cloud service.

Prerequisites

Ensure the omm CLI is available:

command -v omm || npm install -g oh-my-mermaid

If the install command fails (permission denied), tell the user: "Please run npm install -g oh-my-mermaid in your terminal, then try again."

Workflow

Step 1: Check Login Status

Run omm share via Bash. If it errors with "not logged in":

  • Tell the user: "You need to log in first."
  • Run omm login — this opens a browser for GitHub OAuth
  • Wait for the user to complete login

Step 2: Check Project Link

Run omm share via Bash. If it errors with "no project slug":

  • Run omm link — this sets the cloud project slug from the directory name
  • Confirm: "Linked to {slug}"

Step 3: Push

Run omm push via Bash.

Handle errors:

  • 401 Unauthorized: "Login expired. Run omm login again."
  • 403 Free plan limit: "Free plan allows 1 project. Upgrade at https://ohmymermaid.com/pricing"
  • Network error: "Cannot reach server. Check your connection."

Step 4: Report

On success, output:

  • Number of files uploaded
  • View URL: https://ohmymermaid.com/p/{slug}
  • Share URL (if Pro): "Run omm share to get the shareable link"

Rules

  • Always check login before pushing
  • Always check link before pushing
  • Do NOT skip steps — each depends on the previous
  • If any step fails, stop and report the error with guidance