Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

initial docs for npm node #1386

Merged
merged 2 commits into from
May 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions docs/integrations/builtin/app-nodes/n8n-nodes-base.npm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: npm
description: Documentation for the npm node in n8n, a workflow automation platform. Includes details of operations and configuration, and links to examples and credentials information.
---

# npm

The npm node allows you to automate work in npm, and integrate npm with other applications.

On this page, you'll find a list of operations the npm node supports and links to more resources.

!!! note "Credentials"
Refer to [npm credentials](/integrations/builtin/credentials/npm/) for guidance on setting up authentication.

!!! note "Examples and templates"
For usage examples and templates to help you get started, take a look at n8n's [npm integrations](https://n8n.io/integrations/npm/){:target="_blank" .external-link} list.


## Operations
* Package
* Get Package Metadata
* Get Package Versions
* Search for Packages
* Distribution Tag
* Get All Tags
* Update a Tag

## Related resources

View [example workflows and related content](https://n8n.io/integrations/npm/){:target=_blank .external-link} on n8n's website.
24 changes: 24 additions & 0 deletions docs/integrations/builtin/credentials/npm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: npm credentials
description: Documentation for the npm credentials. Use these credentials to authenticate npm in n8n, a workflow automation platform.
---

# npm credentials

You can use these credentials to authenticate the following nodes:

- [npm](/integrations/builtin/app-nodes/n8n-nodes-base.npm/)

## Prerequisites

* An npm account
* An Access Token. Follow [npm's documentation](https://docs.npmjs.com/creating-and-viewing-access-tokens){:target=_blank .external-link} to get your token.

## Using Access Token

--8<-- "_snippets/integrations/builtin/credentials/open-credential-modal-list.md"

1. Copy the Access token from npm into **Access Token**.
2. If you are using a custom npm registry set the **Registry Url**.
3. Select **Save**. n8n tests your credentials and confirms that they work.

1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,7 @@ nav:
- integrations/builtin/credentials/nextcloud.md
- integrations/builtin/credentials/nocodb.md
- integrations/builtin/credentials/notion.md
- integrations/builtin/credentials/npm.md
- integrations/builtin/credentials/odoo.md
- integrations/builtin/credentials/onesimpleapi.md
- integrations/builtin/credentials/onfleet.md
Expand Down