Bimo.Tools
1.4.1
dotnet add package Bimo.Tools --version 1.4.1
NuGet\Install-Package Bimo.Tools -Version 1.4.1
<PackageReference Include="Bimo.Tools" Version="1.4.1" />
<PackageVersion Include="Bimo.Tools" Version="1.4.1" />
<PackageReference Include="Bimo.Tools" />
paket add Bimo.Tools --version 1.4.1
#r "nuget: Bimo.Tools, 1.4.1"
#:package Bimo.Tools@1.4.1
#addin nuget:?package=Bimo.Tools&version=1.4.1
#tool nuget:?package=Bimo.Tools&version=1.4.1
Bimo.Tools
Build custom C# commands for BIMO Add-in for Autodesk Revit.
Bimo.Tools is the public .NET Standard 2.0 SDK that defines how your command DLL communicates with BIMO. It provides attributes for command discovery, settings and input metadata, invocation-scoped service contracts, transaction helpers, and structured results.
BIMO loads your DLL and runs the command inside Revit. This package is not a standalone Revit add-in, a Revit API wrapper, or an MCP server.
Install
Add an exact version of the SDK to your command project:
<PackageReference Include="Bimo.Tools" Version="[1.4.1]" />
Restore from nuget.org. You do not need access to BIMO's private source repositories.
Check host compatibility before upgrading. The BIMO installation must supply a host verified for the SDK contracts used by your DLL. Neither targeting .NET Standard 2.0 nor an unchanged assembly version guarantees compatibility with an older BIMO installation. For Revit API operations, reference the appropriate Autodesk API assemblies separately.
Your first command
A minimal command can be a public static method decorated with [Bimo]:
using Bimo.Tools.Attributes;
using Bimo.Tools.Commands;
using Bimo.Tools.Services;
public static class SelectionCommands
{
// Generate a unique GUID for each new command and keep it stable.
[Bimo(
"65b79817-5cfe-4e2b-a9e8-762cd991bfa7",
DisplayName = "Count selected elements",
RequiredDocument = CommandDocumentRequirement.Project
)]
public static void Count(ICommandSelection selection, IUserNotifier notifier)
{
int count = selection.GetSelectedElementUniqueIds().Count;
if (count == 0)
throw new CommandInputException("Select at least one element.");
notifier.Inform($"Selected elements: {count}");
}
}
Generate a new GUID for your command rather than copying the example's ID. The class and entrypoint must be public and non-generic, and the entrypoint must be static and unambiguous. BIMO supplies supported services as parameters.
To try it:
- Build your command class library in Release mode.
- In Revit, open BIMO → Open Settings → General → DLL commands and add the path to your command DLL.
- Save settings, restart Revit, and run the generated command from the BIMO ribbon.
Do not distribute Bimo.Tools.dll or its satellite assemblies alongside your command DLL. The installed BIMO host provides its own compatible SDK contracts. Load third-party command DLLs only from trusted sources.
Core capabilities
| Capability | What you use |
|---|---|
| Command identity and document requirements | [Bimo], CommandDocumentRequirement |
| Settings and editor metadata | SettingsType, ISettings<T>, input attributes |
| Per-invocation dependency injection | [BimoService] and public service interfaces |
| Results and status | CommandReport, CommandStatusReport |
| Notifications and selection | IUserNotifier, ICommandSelection |
| Revit transaction helpers | ITransactionManager and result-checking extensions |
| Expected, user-correctable errors (1.4+) | CommandInputException |
Throw CommandInputException for a localized, user-safe, correctable input problem. A compatible host classifies it as Failed and displays the message once; you do not need a try/catch at the command entrypoint. Real user cancellation and unexpected Revit/programming failures must not be reclassified as input errors.
Commands can also declare audited AI-agent dry-run and committed-execution capabilities using SupportsAgentDryRun and SupportsAgentCommit. These are explicit opt-ins: the installed BIMO host controls availability and authorization. Installing this SDK does not grant an agent permission to execute commands.
Documentation and examples
- Hello BIMO Quick Start: build, load and run a command in Revit. The example may target an older, compatible pinned SDK version.
- C# command authoring guide: command structure, settings, presets, services, results, and AI-agent execution.
- Hello BIMO example source
- BIMO releases: check installed-host compatibility.
The public SDK repository is a reviewed source snapshot. SDK source publication, NuGet release, and installed-host rollout are separate steps.
License and support
Bimo.Tools is distributed under the MIT License.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. 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. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Newtonsoft.Json (>= 13.0.3)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.