Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 32 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,16 +50,16 @@ determinstic tool.
`napi` aims to support all major programming languages. Here is the current
status:

| Language/Framework | Status | Related Issues |
| ------------------ | -------------- | --------------------------------------------------- |
| Python | ✅ Supported | [#28](https://github.com/nanoapi-io/napi/issues/28) |
| C# | ✅ Supported | [#31](https://github.com/nanoapi-io/napi/issues/31) |
| PHP | 🚧 In Progress | [#30](https://github.com/nanoapi-io/napi/issues/30) |
| Java | 🚧 In Progress | [#32](https://github.com/nanoapi-io/napi/issues/32) |
| C | 🚧 In Progress | Not Tracked Yet |
| C++ | 🚧 In Progress | Not Tracked Yet |
| JavaScript | 🚧 In Progress | Not Tracked Yet |
| TypeScript | 🚧 In Progress | Not Tracked Yet |
| Language/Framework | Status |
| ------------------ | -------------- |
| Python | ✅ Supported |
| C# | ✅ Supported |
| C | ✅ In Progress |
| Java | 🚧 In Progress |
| C++ | 🚧 In Progress |
| PHP | 🚧 In Progress |
| JavaScript | 🚧 In Progress |
| TypeScript | 🚧 In Progress |

For the latest updates, visit our [project board](/projects).

Expand Down Expand Up @@ -104,17 +104,30 @@ Initialize the project. This step is required before running any other command.
This will create a .napirc configuration file in the project root, storing paths
and settings necessary for further commands.

### `napi audit view`
### `napi manifest generate`

Scan and audit your codebase for potential improvements, vulnerabilities, and
maintainability issues. This command opens the NanoAPI UI in your default
browser, providing a clear overview of what areas of your code would benefit
most from refactoring or cleanup.
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.

> **Important**: Run napi audit view periodically, especially before major
> refactoring efforts, to ensure your code is in good shape. It will soon also
> be possible to integrate that command into CI/CD workflows to catch
> architectural-level-quality issues early.
### `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.

### `napi extract`

Extract specific symbols (functions, classes, etc.) from your codebase into
separate files. Use the format `--symbol file|symbol` where file is the path
relative to your project root and symbol is the name to extract. The UI can
generate these commands for convenient copy-pasting when browsing your code.

> **Important**: Run `napi manifest generate` whenever you make significant
> changes to your codebase to ensure your manifest stays up-to-date. The
> manifest data can be integrated into CI/CD workflows to track architectural
> changes over time.

## CI/CD Integration

Expand Down
Loading