> For the complete documentation index, see [llms.txt](https://docs.n8n.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.n8n.io/connect/create-nodes/test-your-node/run-your-node-locally.md). # Run your node locally You can test your node as you build it by running it in a local n8n instance. 1. Install n8n using npm: ```shell npm install n8n -g ``` 2. When you are ready to test your node, publish it locally: ```shell # In your node directory npm run build npm link ``` 3. Install the node into your local n8n instance:
```shell # In the nodes directory within your n8n installation # node-package-name is the name from the package.json npm link ``` ```

Check your directory

Make sure you run npm link <node-name> in the nodes directory within your n8n installation. This can be:

``` 4\. Start n8n: ``` n8n start ``` 5. Open n8n in your browser. You should see your nodes when you search for them in the nodes panel.

Node names

Make sure you search using the node name, not the package name. For example, if your npm package name is n8n-nodes-weather-nodes, and the package contains nodes named rain, sun, snow, you should search for rain, not weather-nodes.

#### Troubleshooting If there's no `custom` directory in `~/.n8n` local installation, you have to create `custom` directory manually and run `npm init`: ```shell # In ~/.n8n directory run mkdir custom cd custom npm init ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.n8n.io/connect/create-nodes/test-your-node/run-your-node-locally.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.