"Fossies" - the Fresh Open Source Software Archive

Member "Atom/resources/app/apm/README.md" (11 Apr 2017, 3225 Bytes) of package /windows/misc/atom-windows.zip:

As a special service "Fossies" has tried to format the requested source page into HTML format (assuming markdown format). Alternatively you can here view or download the uninterpreted source code file. A member file download can also be achieved by clicking within a package contents listing on the according byte size field.

apm - Atom Package Manager

OS X Build Status Windows Build Status Dependency Status

Discover and install Atom packages powered by atom.io

You can configure apm by using the apm config command line option (recommended) or by manually editing the ~/.atom/.apmrc file as per the npm config.

Relation to npm

apm comes with npm and spawns npm processes to install Atom packages. The major difference is that apm sets multiple command line arguments to npm to ensure that native modules are built against Chromium's v8 headers instead of node's v8 headers.

The other major difference is that Atom packages are installed to ~/.atom/packages instead of a local node_modules folder and Atom packages are published to and installed from GitHub repositories instead of npmjs.com

Therefore you can think of apm as a simple npm wrapper that builds on top of the many strengths of npm but is customized and optimized to be used for Atom packages.


apm is bundled and installed automatically with Atom. You can run the Atom > Install Shell Commands menu option to install it again if you aren't able to run it from a terminal (Mac OS X only).


Why bin/npm / bin\npm.cmd?

apm includes npm, and spawns it for various processes. It also comes with a bundled version of Node, and this script ensures that npm uses the right version of Node for things like running the tests. If you're using the same version of Node as is listed in BUNDLED_NODE_VERSION, you can skip using this script.


Run apm help to see all the supported commands and apm help <command> to learn more about a specific command.

The common commands are apm install <package_name> to install a new package, apm featured to see all the featured packages, and apm publish to publish a package to atom.io.

Behind a firewall?

If you are behind a firewall and seeing SSL errors when installing packages you can disable strict SSL by running:

apm config set strict-ssl false

Using a proxy?

If you are using a HTTP(S) proxy you can configure apm to use it by running:

apm config set https-proxy

You can run apm config get https-proxy to verify it has been set correctly.

Viewing configuration

You can also run apm config list to see all the custom config settings.