npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@mermaidchart/cli

v0.1.0

Published

CLI for interacting with https://MermaidChart.com, the platform that makes collaborating with Mermaid diagrams easy

Downloads

804

Readme

@mermaidchart/cli

CLI for interacting with https://MermaidChart.com, the platform that makes collaborating with Mermaid diagrams easy!

Installation

@mermaidcart/cli is tested to work with Node.JS v18.18.0 or later.

We recommend installation using npx to automatically download, cache, and run @mermaidcart/cli, as it comes with most Node.JS installations.

npx @mermaidchart/cli --help

Usage

npx @mermaidchart/cli <command>

Use --help to see options!

npx @mermaidchart/cli --help

@mermaidchart/cli allows you to easily sync local diagrams with your diagrams on https://mermaidchart.com.

These local diagrams can either be stored in .mmd or .mermaid files, or they can be stored within ```mermaid code blocks within .md GFM markdown files.

login

Firstly, go to https://www.mermaidchart.com/app/user/settings and generate an API key, which you can then setup by running:

npx @mermaidchart/cli login

link an existing Mermaid diagram to MermaidChart.com

You can link a local Mermaid diagram to MermaidChart using:

npx @mermaidchart/cli link ./path/to/my/mermaid-digram.mmd

This will add an id: xxxx-xxxxx-xxxxx field to your diagram's YAML frontmatter, which points to the diagram on MermaidChart.com:

```mermaid
---
title: My diagram
id: https://www.mermaidchart.com/d/xxxx-xxxxx-xxxxx # this field is created by @mermaidchart/cli
---
flowchart
  x[My Diagram]
```

push local changes to MermaidChart.com

Once you've made some local changes, you can push your changes to MermaidChart.com

$ npx @mermaidchart/cli push ./path/to/my/mermaid-digram.mmd
✅ - ./path/to/my/mermaid-digram.mmd was pushed

pull changes from MermaidChart.com

You can use pull to pull down changes from MermaidChart.com.

$ npx @mermaidchart/cli pull ./path/to/my/mermaid-digram.mmd
✅ - ./path/to/my/mermaid-digram.mmd was updated

Or use the --check flag to throw an error if your local file would have been updated:

$ npx @mermaidchart/cli pull ./path/to/my/mermaid-digram.mmd
❌ - ./path/to/my/mermaid-digram.mmd would be updated

Contributing

For local development and testing, you can pnpm dev to run the CLI, pnpm run lint to run linting, and pnpm test to run unit tests.