Community Package API

CommunityPackageClient manages n8n community packages — install, update, and uninstall npm packages.

Use this handle for package lifecycle operations in n8n instances that allow community nodes.

Access

const communityPackage = client.communityPackages();

Methods

Common Tasks

• list installed community packages
• install a package from npm
• update a package to a specific version
• uninstall packages that are no longer used

list()

List all installed community packages.

const packages = await client.communityPackages().list();

install(data)

Install a community package.

const pkg = await client.communityPackages().install({
  name: 'n8n-nodes-test',
  verify: true,
});

update(name, data?)

Update a community package.

const updated = await client.communityPackages().update('n8n-nodes-test', {
  version: '1.0.0',
  verify: true,
});

uninstall(name)

Uninstall a community package.

await client.communityPackages().uninstall('n8n-nodes-test');

CommunityPackageResource

Use getResource() or installResource() to get a bound CommunityPackageResource instance.

const resource = await client.communityPackages().getResource('n8n-nodes-test');
const installed = await client.communityPackages().installResource({
  name: 'n8n-nodes-test',
  verify: true,
});

Properties

Property	Type	Description
packageName	string	npm package name
installedVersion	string	Currently installed version

Methods

Method	Returns	Description
refresh()	this	Re-fetch the package from the API — resolves by name from list
update(data?)	this	Update the package — replaces snapshot with the API response
patch(data?)	this	Convenience update — uses the installed version as the base payload, then merges partial fields over it
uninstall()	void	Uninstall the package

Note

getResource() resolves by package name from the list endpoint — there is no direct GET /community-packages/{name} in the n8n API. The name-based lookup ensures the package exists before returning a resource.