Troubleshooting

How do I report bugs or get support?

The quickest way to get support is by dropping us a line on Discord.

The second fastest way is to open an issue on GitHub.

We can also create a shared Slack or Teams channel with you upon a purchase of our Enterprise License.

The command isn’t running on my codebase

While there are several reasons for this, the most likely is our language support. We implement each language individually, and might not yet support your preferred language (though we are working on it).

Please check out our Supported Languages Page or our GitHub readme to see which languages we currently support.

NanoAPI is consuming too much memory/CPU — how can I tune performance?

For now the performance of napi is tied directly to the size of the codebase you are running against. Most computers should run codebases up to a million lines of code without any issues.

We are working on support for handling larger codebases on small machines.

The CLI is showing weird characters on Windows when running on Powershell or CMD

You're encountering ANSI escape sequences like [8B, <[2K, etc., showing as literal garbage in the CLI output — this typically happens when the terminal doesn't properly support ANSI codes. The NanoAPI CLI makes use of these to give a clean experience while running commands.

In these cases we recommend you use Windows Terminal or upgrade to Powershell 7+. Both options will fix the issues. Of course, keeping your version of windows up to date with the latest will also ensure you have the latest security fixes on your device as well.

TL;DR

⚠️ If you see weird characters like [2K, [8B, or gibberish:

  1. Use Powershell 7+ or Windows Terminal

  2. If using Powershell, these commands can help:

    1. $env:TERM = "xterm"
      $env:FORCE_COLOR = "1"
      
  3. Avoid piping output or using cmd.exe in legacy mode

  4. For best results, install Windows Subsystem for Linux and the linux binaries

Updated on