Gatsby Package Manager gpm

Install

# Install globally via npm.
npm install -g gatsby-package-manager

# OR: Install globally via yarn.
yarn global add gatsby-package-manager

Now you have access to gpm or gatsby-package-manager in your command line.

Usage

❯ Install a package

Installs a Gatsby package with all of its peer dependencies.

# 1: Interactive mode.
# Type `gpm` and answer the questions asked.
gpm

# Alternatively, you can also run it via:
gatsby-package-manager

# 2: Direct mode.
# Several ways to run the same command.
gpm install <pkgName>
gpm i <pkgName>
gpm install gatsby-plugin-mdx
gpm i gatsby-plugin-mdx

❯ Docs for a package

Prints the docs, i.e., readme.md file of a package in the command line.

# Several ways to run the same command.
gpm docs <pkgName>
gpm d <pkgName>
gpm docs gatsby-plugin-mdx
gpm d gatsby-plugin-mdx

❯ Configure npm or yarn

The gatsby-package-manager (gpm) stores your choice of using npm or yarn in ~/.config/configstore/gatsby-package-manager.json file. This choice can be re-configured by using the option --config or -c when running gpm.

gpm --config
gpm -c
gpm i gatsby-plugin-mdx -c

❯ Help documentation

You can run gpm --help or gpm -h to access the help documentation.

API: Plugin Authors

Make sure you mention all the extra dependencies as peerDependencies in the package.json file.

The peerDependencies in the package.json is what gatsby-package-manager looks for. For example: The gatsby-plugin-mdx has defined two peerDependencies @mdx-js/mdx and @mdx-js/react which are required for the installation.

Changelog

❯ Read the changelog here →

KEY: 📦 NEW, 👌 IMPROVE, 🐛 FIX, 📖 DOC, 🚀 RELEASE, and ✅ TEST

I use Emoji-log, you should try it and simplify your git commits.

Nothing's ever complete, so bear with me while we keep iterating towards a better future.

'Coz every night I lie in bed
The brightest colors fill my head
A million dreams are keeping me awake
I think of what the world could be
A vision of the one I see
A million dreams is all it's gonna take
A million dreams for the world we're gonna make ...

... listen to → A million dreams!

License & Conduct

• MIT © Ahmad Awais
• Logo by Saqib Ameen
• Code of Conduct
• Contribute to gatsby-package-manager

Connect

Sponsor

Me (Ahmad Awais) and my incredible wife (Maedah Batool) are two engineers who fell in love with open source and then with each other. You can read more about me here. If you or your company use any of my projects or like what I’m doing then consider backing me. I'm in this for the long run. An open-source developer advocate.

• 🌟 $9.99/month (recommended) ❯ Two cups of Caffè latte (coffee) every month →
• 🚀 $99.99 (one-time sponsor) ❯ Support an hour of open-source code →
• 🔰 $49.99 (one-time sponsor) ❯ Support an hour of maintenance →
• ☕️ $9.99 (one-time sponsor) ❯ Lunch/coffee →

Or you can back me by checking out my super fun video course. As developers, we spend over 200 Hrs/month with our code editors — it's only fair to learn your next editor deeply. This course will save you 15-20 hours every month. Become a VSCode Power User →

VSCODE