napi

napi is a versatile tool designed to help you understand and evolve your software architecture. It offers a powerful CLI and a UI to audit, refactor, and build modular components from your codebase. Use the CLI to login to NanoAPI, initialize projects, generate manifests, and extract symbols for refactoring. The UI provides an interactive way to explore architectures, run refactors, and assemble modular microservices ready for deployment. This combination makes napi suitable for integration into CI/CD workflows and for teams that want visibility into architectural decisions across languages and platforms.

Key capabilities include: auditing architectural hotspots that need refactoring, extracting functionality into smaller units, and building modular monoliths or microservices from an existing codebase. napi supports a wide range of languages and aims to be CI/CD friendly, enabling automated manifest generation and architecture tracking over time. You can use the CLI for automation in scripts and pipelines, and the UI for hands-on exploration and guided refactoring tasks.

Prerequisites:

• Node.js (v14+ recommended) and npm/yarn installed on your system
• Access to the internet to fetch the napi package

Installation options:

1. Quick installer script (recommended):

curl -fsSL https://raw.githubusercontent.com/nanoapi-io/napi/refs/heads/main/install_scripts/install.sh | bash

This script will install napi on macOS/Linux. If you’re on Windows, follow option 2 or use WSL as noted in the documentation.

2. Manual installation via npm (alternative):

npm install -g napi

After installation, verify the CLI is accessible:

napi --help

3. Windows-specific notes:

• napi can run on Windows primarily through Windows Subsystem for Linux (WSL). See the docs for guidance on enabling WSL and using napi within the Linux environment provided by WSL.

4. Official release download (optional):

• You can also download and install the latest release directly from the project releases page: https://github.com/nanoapi-io/napi/releases/latest

Environment and configuration hints:

• You may need to authenticate with NanoAPI to access certain UI features or manifests. Use napi login to authenticate.
• For CI/CD integration, use manifest generate in your pipeline to capture the current code structure and push it to your NanoAPI workspace.
• If you encounter issues during installation, consult the Troubleshooting Guide linked in the project docs.
• The tool supports multiple languages; ensure your codebase is in a language currently supported by napi for best results. Some languages may be in progress and marked accordingly in the status table.
• When integrating into pipelines, consider running napi manifest generate as a separate step to keep architectural data up to date with your code changes.