Frumle 0.1.0
See the version list below for details.
dotnet tool install --global Frumle --version 0.1.0
dotnet new tool-manifest
dotnet tool install --local Frumle --version 0.1.0
#tool dotnet:?package=Frumle&version=0.1.0
nuke :add-package Frumle --version 0.1.0
Frumle - AI-Powered Codebase Analyzer for .NET
AI-powered codebase analyzer and API documentation generator for .NET / C# projects.
Installation
dotnet tool install -g Frumle
Quick Start
# 1. Add your API key (get one at https://frumle.tellecata.com)
frumle add-key <your-api-key>
# 2. Analyze your project
frumle analyze ./MyProject
Commands
frumle add-key <api-key>
Add and verify your API key. Also available as frumle set-key or frumle login.
frumle status
Check your API key status and remaining quota.
frumle analyze [directory]
Analyze a .NET codebase. Defaults to the current directory.
Options:
--ignore <dirs>— Comma-separated directories to ignore (default:bin,obj,.vs,.git,packages,node_modules,TestResults)--project-name <name>— Project name (defaults to.csprojname,.slnname, or directory name)
Default command
Running frumle [directory] without a subcommand will analyze the given directory.
Supported File Types
.cs, .csproj, .sln, .json, .xml, .razor, .cshtml, .config, .resx, .xaml, .props, .targets, .md, .yaml, .yml, .proto, .graphql, .fs, .fsx, .fsproj, .vb, .vbproj
Configuration
User config
Your API key is stored in ~/.frumle/config.json. You can also set the FRUMLE_API_KEY environment variable.
Project config
A frumle.config.json file is automatically created/updated in your project root with detected base URLs:
{
"baseUrls": [
{ "environment": "local", "url": "http://localhost:5000" },
{ "environment": "production", "url": "" }
]
}
The local URL is auto-detected from launchSettings.json, .env files, appsettings.json, or Program.cs.
Environment Variables
| Variable | Description |
|---|---|
FRUMLE_API_KEY |
API key (overrides config file) |
FRUMLE_API_URL |
API base URL (for self-hosted backends) |
Requirements
- .NET 8.0 or later
License
MIT — Tellecata LLC
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
This package has no dependencies.