FAQs

v1.0

🔧 Installation & Setup How do I install NanoAPI via npm? Check the Getting Started guide. The short version: npm i -g @nanoapi.io/napi What

🔧 Installation &amp; Setup How do I install NanoAPI via npm? Check the Getting Started guide. The short version: npm i -g @nanoapi.io/napi What are the system requirements for running NanoAPI? For now, Node.js &gt;= v22.x. We plan to support older versions of node in the future. The tool is outputting warnings during installation. How do I fix this? This is a known issue. We are working to fix this. Currently, this will not cause any issues with your system or the execution of the tool. How do I update NanoAPI to the latest version? npm i -g @nanoapi.io/napi 🚀 Usage Basics How do I open the UI after starting the CLI? After running the napi audit view command, the UI can normally be found at: http://localhost:3000/#/audit The CLI is smart, however, and will begin searching for the first open port if port 3000 is already in use on your computer. It will start from 3001 and move upwards. Can I use NanoAPI in CI environments or headless mode? You can! napi audit run —ci is built for just such a use case. Check the CLI reference for more info. 🧑‍💻 Language Support How can I request or contribute support for another language? You can start by opening an issue on GitHub or sending us a message on Discord . How does NanoAPI handle mixed-language monorepos? For now, mixed-language monorepos require each service to have it’s own .napirc . This is something that we may introduce better support for in the future, but we want to hear from you if you have this issue before we start work on it. 🖥️ Frontend &amp; UI The UI isn't loading in my browser — what should I check? Make sure you’re on the right page. Opening the browser to http://localhost:3000 might show an empty page. If this happens, make sure your browser is pointed to http://localhost:3000/#/audit Can I change the port that the UI runs on? Not at the moment. We may add support for this in the future. Does the UI require internet access or can it run offline? The UI can run offline. 🧠 Symbol Extractor Does napi edit my code? No, the CLI tool does not edit your code. Our tool builds a tree structure from your code and then edits the branches in-place. No code is added or removed, only moved around. If you have the time, we encourage you to deep dive into our source code to see how we do it. What does the symbol extractor do? This guide explains it best. Put simply: NanoAPI’s symbol extraction is a powerful way of pulling functionality out of existing codebases for the purposes of creating smaller codebases, microservices, or serverless functions. Can I export the results of the symbol extraction? You can! There are two ways of doing this: 1. Take the exported functionality from napi_dist After the symbol extraction runs, you will have a fully-formed codebase within napi_dist folder (or wherever you configured the output to go in .napirc . This can be taken and run directly. We always encourage you to double-check your codebase before running it in production. 2. Export selected extractions to JSON files When using the UI or CLI to do extraction, you can specify to output the result of the extraction as a JSON file. These JSON files can then later be passed to the CLI to perform the split along the same lines. Great for running in a CI pipeline! ⚙️ Advanced Features Can I use NanoAPI across multiple codebases or repositories? Not yet. We are working on this however and will include this functionality in the release of our cloud hosted version. Please join the waitlist to be notified .

🔧 Installation &amp; Setup How do I install NanoAPI via npm? Check the Getting Started guide. The short version: npm i -g @nanoapi.io/napi What