Merge pull request #156 from nanoapi-io/chore/windows-support

Add powershell install script for windows, verify windows support

Author: florianbgt

README.md

@@ -1,5 +1,7 @@
 ![NanoAPI Banner](/media/github-banner.png)
 
+- [Documentation](https://docs.nanoapi.io)
+
 # napi - Better Software Architecture for the AI Age
 
 `napi` is a versatile tool built by NanoAPI and designed to automatically
@@ -34,6 +36,9 @@ determinstic tool.
 
 ## Why `napi`?
 
+- **Application Library**: `napi` is not just a CLI tool; it is a comprehensive
+  application library of all projects and their interactions within your
+  organization.
 - **Enables discovery into legacy systems**: indentify problematic code and
   potential improvements early.
 - **Modular Monoliths**: Simplifies the process of extracting functionality
@@ -65,24 +70,34 @@ For the latest updates, visit our [project board](/projects).
 
 ## Installation
 
-`napi` works out of the box on both mac and linux systems.
+`napi` works out of the box on both mac, linux, and windows systems.
 
-To use this tool on Windows, you will need to install and run the CLI commands
-from there.
+To install `napi`, you can use our installation script:
 
-[WSL (Windows Subsystem for Linux)](https://learn.microsoft.com/en-us/windows/wsl/install)
+### Unix Systems (MacOS, Linux)
 
-To install `napi`, you can use our installation script:
+Wyou to install napi using our convenience script:
 
 ```bash
 curl -fsSL https://raw.githubusercontent.com/nanoapi-io/napi/refs/heads/main/install_scripts/install.sh | bash
 ```
 
-Our download and install manually from:
+You can also download and install the latest release manually directly from our
+GitHub repository:
 
 https://github.com/nanoapi-io/napi/releases/latest
 
-This will download and install the latest version of `napi` to your system.
+### Windows
+
+You can run napi using Windows Subsystem for Linux (WSL)
+https://learn.microsoft.com/en-us/windows/wsl/install
+
+We are actively working on supporting windows natievely.
+
+### Troubleshooting
+
+If you encounter any issues during installation, please refer to our
+[Troubleshooting Guide](https://docs.nanoapi.io/default-guide/troubleshooting)
 
 ## CLI Usage
 
@@ -97,6 +112,11 @@ napi --help
 
 ## Overview of all commands
 
+### `napi login`
+
+Authenticate with the NanoAPI service. This step is required to access the
+NanoAPI UI and to use certain features of `napi`.
+
 ### `napi init`
 
 Initialize the project. This step is required before running any other command.
@@ -107,15 +127,7 @@ and settings necessary for further commands.
 ### `napi manifest generate`
 
 Generate a manifest of your codebase that captures its structure, dependencies,
-and relationships. This command analyzes your code and writes the manifest data
-to the configured `napi_out` directory in your project.
-
-### `napi manifest view`
-
-Open the NanoAPI UI in your default browser to visualize and explore the
-manifest generated by `napi manifest generate`. This provides an interactive
-view of your codebase's architecture, helping you identify areas for potential
-improvements and refactoring.
+and relationships and pushes it to your NanoAPI workspace in the app.
 
 ### `napi extract`
 

install_scripts/install.ps1

@@ -0,0 +1,46 @@
+# PowerShell script to install NanoAPI CLI on Windows
+
+$ErrorActionPreference = "Stop"
+
+# Define platform-specific filename
+$FILENAME = "napi.exe"
+$RELEASE_URL = "https://github.com/nanoapi-io/napi/releases/latest/download/"
+$DOWNLOAD_URL = "$RELEASE_URL$FILENAME"
+
+# Define install path (add this path to your system PATH if needed)
+$INSTALL_DIR = "$env:ProgramFiles\NanoAPI"
+$INSTALL_PATH = Join-Path $INSTALL_DIR "napi.exe"
+$BACKUP_PATH = "$INSTALL_PATH.bak"
+
+# Create install directory if it doesn't exist
+if (-Not (Test-Path $INSTALL_DIR)) {
+    New-Item -ItemType Directory -Path $INSTALL_DIR | Out-Null
+}
+
+# Backup existing binary
+if (Test-Path $INSTALL_PATH) {
+    Write-Output "Existing version found, creating a backup..."
+    Move-Item -Force -Path $INSTALL_PATH -Destination $BACKUP_PATH
+} else {
+    Write-Output "No existing version found, proceeding with installation."
+}
+
+# Download the binary
+$TEMP_PATH = Join-Path $env:TEMP $FILENAME
+Write-Output "Downloading the latest version of $FILENAME..."
+Invoke-WebRequest -Uri $DOWNLOAD_URL -OutFile $TEMP_PATH
+
+# Install the binary
+Write-Output "Installing new version..."
+try {
+    Move-Item -Force -Path $TEMP_PATH -Destination $INSTALL_PATH
+    Write-Output "Installation/Update successful! You can now use your CLI by typing 'napi' if it's in your PATH."
+} catch {
+    Write-Error "Update failed! Restoring the old version..."
+    if (Test-Path $BACKUP_PATH) {
+        Move-Item -Force -Path $BACKUP_PATH -Destination $INSTALL_PATH
+        Write-Output "Restored the old version. Please try again later."
+    } else {
+        Write-Error "Backup not found. Manual intervention required."
+    }
+}

src/cli/handlers/init/index.ts

@@ -3,7 +3,7 @@ import {
   createConfig,
   getConfigFromWorkDir,
 } from "../../middlewares/napiConfig.ts";
-import { join, normalize, relative } from "@std/path";
+import { join, normalize, relative, SEPARATOR } from "@std/path";
 import type z from "zod";
 import type { localConfigSchema } from "../../middlewares/napiConfig.ts";
 import pythonStdlibList from "../../../scripts/generate_python_stdlib_list/output.json" with {
@@ -80,7 +80,7 @@ async function handler(
     if (confirmSave) {
       createConfig(napiConfig, argv.workdir);
       console.info("\n✅ Configuration saved successfully!");
-      console.info(`📄 Created: ${argv.workdir}/.napirc`);
+      console.info(`📄 Created: ${argv.workdir}${SEPARATOR}.napirc`);
       console.info("🎉 Your NanoAPI project is ready!");
     } else {
       console.info("❌ Configuration not saved");
@@ -238,8 +238,8 @@ async function collectIncludePatterns(
 Include patterns define which files NanoAPI will process and analyze.
 
 Examples:
-- '**/*.py' for all Python files
-- 'src/**' for all files in src directory
+- '**${SEPARATOR}*.py' for all Python files
+- 'src${SEPARATOR}**' for all files in src directory
 - '*.py' for all Python files in the root directory
 `,
   );
@@ -281,7 +281,8 @@ Examples:
 
     while (continueAdding) {
       const pattern = await input({
-        message: "Enter glob pattern (e.g., '**/*.py', 'src/**')",
+        message:
+          `Enter glob pattern (e.g., '**${SEPARATOR}*.py', 'src${SEPARATOR}**')`,
         validate: (value) => {
           if (!value.trim()) return "Pattern cannot be empty";
           try {
@@ -363,9 +364,9 @@ async function collectExcludePatterns(
 Exclude patterns define which files NanoAPI will ignore during processing.
 
 Examples:
-- 'node_modules/**' to exclude all node modules
-- '**/*.test.js' to exclude all JavaScript test files
-- '.git/**' to exclude git directory
+- 'node_modules${SEPARATOR}**' to exclude all node modules
+- '**${SEPARATOR}*.test.js' to exclude all JavaScript test files
+- '.git${SEPARATOR}**' to exclude git directory
 `,
   );
 
@@ -410,7 +411,8 @@ Examples:
 
     while (continueAdding) {
       const pattern = await input({
-        message: "Enter glob pattern (e.g., 'node_modules/**', '**/*.test.js')",
+        message:
+          `Enter glob pattern (e.g., 'node_modules${SEPARATOR}**', '**${SEPARATOR}*.test.js')`,
         validate: (value) => {
           if (!value.trim()) return "Pattern cannot be empty";
           try {
@@ -488,45 +490,67 @@ function suggestIncludePatterns(
   // Language-specific suggestions
   if (language === pythonLanguage) {
     // Check for common Python project structures
-    if (projectStructure.some((entry) => entry.includes("📂 src/"))) {
-      suggestions.push("src/**/*.py");
+    if (
+      projectStructure.some((entry) => entry.includes(`📂 src${SEPARATOR}`))
+    ) {
+      suggestions.push(`src${SEPARATOR}**${SEPARATOR}*.py`);
     }
-    if (projectStructure.some((entry) => entry.includes("📂 lib/"))) {
-      suggestions.push("lib/**/*.py");
+    if (
+      projectStructure.some((entry) => entry.includes(`📂 lib${SEPARATOR}`))
+    ) {
+      suggestions.push(`lib${SEPARATOR}**${SEPARATOR}*.py`);
     }
     if (suggestions.length === 0) {
-      if (projectStructure.some((entry) => entry.includes("📂 app/"))) {
-        suggestions.push("app/**/*.py");
+      if (
+        projectStructure.some((entry) => entry.includes(`📂 app${SEPARATOR}`))
+      ) {
+        suggestions.push(`app${SEPARATOR}**${SEPARATOR}*.py`);
       }
     }
 
     // If no specific directories found, suggest all Python files
     if (suggestions.length === 0) {
-      suggestions.push("**/*.py");
+      suggestions.push(`**${SEPARATOR}*.py`);
     }
   } else if (language === csharpLanguage) {
     // Check for common C# project structures
-    if (projectStructure.some((entry) => entry.includes("📂 src/"))) {
+    if (
+      projectStructure.some((entry) => entry.includes(`📂 src${SEPARATOR}`))
+    ) {
       suggestions.push("src/**/*.cs");
     }
-    if (projectStructure.some((entry) => entry.includes("📂 lib/"))) {
-      suggestions.push("lib/**/*.cs");
+    if (
+      projectStructure.some((entry) => entry.includes(`📂 lib${SEPARATOR}`))
+    ) {
+      suggestions.push(`lib${SEPARATOR}**${SEPARATOR}*.cs`);
     }
     if (suggestions.length === 0) {
-      if (projectStructure.some((entry) => entry.includes("📂 Controllers/"))) {
-        suggestions.push("Controllers/**/*.cs");
+      if (
+        projectStructure.some((entry) =>
+          entry.includes(`📂 Controllers${SEPARATOR}`)
+        )
+      ) {
+        suggestions.push(`Controllers${SEPARATOR}**${SEPARATOR}*.cs`);
       }
-      if (projectStructure.some((entry) => entry.includes("📂 Models/"))) {
-        suggestions.push("Models/**/*.cs");
+      if (
+        projectStructure.some((entry) =>
+          entry.includes(`📂 Models${SEPARATOR}`)
+        )
+      ) {
+        suggestions.push(`Models${SEPARATOR}**${SEPARATOR}*.cs`);
       }
-      if (projectStructure.some((entry) => entry.includes("📂 Services/"))) {
-        suggestions.push("Services/**/*.cs");
+      if (
+        projectStructure.some((entry) =>
+          entry.includes(`📂 Services${SEPARATOR}`)
+        )
+      ) {
+        suggestions.push(`Services${SEPARATOR}**${SEPARATOR}*.cs`);
       }
     }
 
     // If no specific directories found, suggest all C# files
     if (suggestions.length === 0) {
-      suggestions.push("**/*.cs");
+      suggestions.push(`**${SEPARATOR}*.cs`);
     }
   }
 
@@ -544,36 +568,36 @@ function suggestExcludePatterns(
   const suggestions: string[] = [];
 
   // add outDir to the suggestions
-  suggestions.push(`${outDir}/**`);
+  suggestions.push(`${outDir}${SEPARATOR}**`);
 
   // Common exclusions for all languages
-  suggestions.push(".git/**");
-  suggestions.push("**/dist/**");
-  suggestions.push("**/build/**");
+  suggestions.push(`.git${SEPARATOR}**`);
+  suggestions.push(`**${SEPARATOR}dist${SEPARATOR}**`);
+  suggestions.push(`**${SEPARATOR}build${SEPARATOR}**`);
 
   // Language-specific suggestions
   if (language === pythonLanguage) {
-    suggestions.push("**/__pycache__/**");
-    suggestions.push("**/*.pyc");
-    suggestions.push("**/.pytest_cache/**");
-    suggestions.push("**/venv/**");
-    suggestions.push("**/.env/**");
-    suggestions.push("**/*.egg-info/**");
-    suggestions.push("**/.tox/**");
-    suggestions.push("**/.coverage");
-    suggestions.push("**/htmlcov/**");
-    suggestions.push("**/.mypy_cache/**");
+    suggestions.push(`**${SEPARATOR}__pycache__${SEPARATOR}**`);
+    suggestions.push(`**${SEPARATOR}*.pyc`);
+    suggestions.push(`**${SEPARATOR}.pytest_cache${SEPARATOR}**`);
+    suggestions.push(`**${SEPARATOR}venv${SEPARATOR}**`);
+    suggestions.push(`**${SEPARATOR}.env${SEPARATOR}**`);
+    suggestions.push(`**${SEPARATOR}*.egg-info${SEPARATOR}**`);
+    suggestions.push(`**${SEPARATOR}.tox${SEPARATOR}**`);
+    suggestions.push(`**${SEPARATOR}.coverage`);
+    suggestions.push(`**${SEPARATOR}htmlcov${SEPARATOR}**`);
+    suggestions.push(`**${SEPARATOR}.mypy_cache${SEPARATOR}**`);
   } else if (language === csharpLanguage) {
-    suggestions.push("**/bin/**");
-    suggestions.push("**/obj/**");
-    suggestions.push("**/packages/**");
-    suggestions.push("**/.vs/**");
-    suggestions.push("**/TestResults/**");
-    suggestions.push("**/*.user");
-    suggestions.push("**/*.suo");
-    suggestions.push("**/.nuget/**");
-    suggestions.push("**/artifacts/**");
-    suggestions.push("**/packages/**");
+    suggestions.push(`**${SEPARATOR}bin${SEPARATOR}**`);
+    suggestions.push(`**${SEPARATOR}obj${SEPARATOR}**`);
+    suggestions.push(`**${SEPARATOR}packages${SEPARATOR}**`);
+    suggestions.push(`**${SEPARATOR}.vs${SEPARATOR}**`);
+    suggestions.push(`**${SEPARATOR}TestResults${SEPARATOR}**`);
+    suggestions.push(`**${SEPARATOR}*.user`);
+    suggestions.push(`**${SEPARATOR}*.suo`);
+    suggestions.push(`**${SEPARATOR}.nuget${SEPARATOR}**`);
+    suggestions.push(`**${SEPARATOR}artifacts${SEPARATOR}**`);
+    suggestions.push(`**${SEPARATOR}packages${SEPARATOR}**`);
   }
 
   return suggestions;

src/cli/handlers/manifest/generate.ts

@@ -259,6 +259,8 @@ async function handler(
           Deno.exit(1);
         }
 
+        const responseBody = await response.json() as { id: number };
+
         const duration = Date.now() - start;
         console.info(
           `✅ Manifest uploaded successfully for project id: ${projectId} in ${duration}ms`,
@@ -269,7 +271,7 @@ async function handler(
 
         if (globalConfig.apiHost === defaultApiHost) {
           console.info(
-            `\nView it here: https://app.nanoapi.io/projects/${projectId}/manifests`,
+            `\nView it here: https://app.nanoapi.io/projects/${projectId}/manifests/${responseBody.id}`,
           );
         }
       } catch (error) {