Saury Revit Project Creator

Based on the

Saury.Revit.Template

dotnet template, create a fully configured Revit 2026 plugin project (MVVM + DI architecture) through an interactive process.

Workflow

Execute the following steps in order, proceed to the next step only after completing the current one.

Step 1: Interactive Confirmation of Project Configuration

Before executing any commands, you must confirm the following information with the user:

Required Questions:

Project Name — Must be a valid C# namespace name (e.g.,
```
Acme.WallTools
```
,
```
JD.RevitHelper
```
), default is
```
RevitDemo
```
or
```
RevitTest
```
. This name will be used for the solution, project folder, namespace, assembly, addin file, and Ribbon tab.
Project Creation Directory — Defaults to the current working directory.

Optional (with default values, only need confirmation): 3. Revit Version — Default is

, specified via the

--RevitVersion

parameter.

After user confirmation, summarize the configuration and ask for final confirmation before execution.

Step 2: Check and Install .NET Environment

Detection Process (execute in order):

Check if dotnet CLI exists:

bash

where dotnet

If the command exists, check SDK version:

bash

dotnet --list-sdks

Check if the output includes SDK version

8.0

or higher.

Judgment Results:
- dotnet CLI exists and SDK 8.0+ is installed → Skip, proceed to next step
- dotnet CLI exists but no SDK or version is insufficient → Need to install SDK
- dotnet CLI does not exist → Need full installation

Installation Methods (try in priority order):

bash

winget install Microsoft.DotNet.SDK.8

Re-verify after installation:
```
where dotnet && dotnet --list-sdks
```
If
```
winget
```
is unavailable, use the official script for installation:

powershell

Invoke-WebRequest -Uri https://dot.net/v1/dotnet-install.ps1 -OutFile dotnet-install.ps1
./dotnet-install.ps1 -Channel 8.0

If the above methods all fail, inform the user to download .NET 8.0 SDK manually

Step 3: Install Template

bash

# Check if already installed
dotnet new list saury-revit

If already installed → Skip, inform the user it's already installed
If not installed → Execute installation:

bash

dotnet new install Saury.Revit.Template

If update is needed →

dotnet new install Saury.Revit.Template --force

Step 4: Create Project

bash

dotnet new saury-revit -n <Project Name> -o <Output Directory>

Parameter	Description	Example
`-n`	Project Name (replaces all instances of `Saury.Revit.Template` )	`Acme.WallTools`
`-o`	Output Directory	`./Acme.WallTools`
`--RevitVersion`	Revit Version (default 2026)	`2026`

Template Auto-Completion:

Global replacement of
```
Saury.Revit.Template
```
→ User's project name
Automatically generate unique GUID to replace
```
ADDIN-GUID-PLACEHOLDER
```

Exclude

.template.config/

bin/

obj/

.vs/

Logs/

*.user

Step 5: Verify Project Structure

After creation, list the directory to confirm the structure is complete:

<Project Name>/
├── <Project Name>.slnx
└── <Project Name>/
    ├── Commands/AboutCommand.cs
    ├── Extensions/DataContextExtension.cs
    ├── Models/AboutInfo.cs
    ├── ViewModels/AboutViewModel.cs
    ├── Views/AboutView.xaml(.cs)
    ├── Resources/Icons/about.png
    ├── Resources/Styles/ButtonStyles.xaml
    ├── Services/Interfaces/
    ├── Application.cs
    ├── Host.cs
    ├── appsettings.json
    ├── <Project Name>.addin
    └── <Project Name>.csproj

Step 6: Build Verification

bash

cd <Output Directory>
dotnet restore
dotnet build --configuration Debug_R26

Critical Note: This project uses

Debug_R26

Release_R26

, do not use the standard

Debug

Release

, otherwise the build will fail.

After successful build, the compiled artifacts are automatically copied to

C:\ProgramData\Autodesk\Revit\Addins\2026\

Step 7: Inform User on How to Use

After successful build, display the following usage instructions to the user:

Debug Launch Configuration

Modify Revit Path — Open
```
<Project Name>.csproj
```
, find the
```
StartProgram
```
property, confirm the path points to the local Revit installation location:

xml

<StartProgram>C:\Program Files\Autodesk\Revit 2026\Revit.exe</StartProgram>

If Revit is installed in a non-default path, modify it to the actual path.

Open
```
<Project Name>.slnx
```
with Visual Studio or Rider
Select build configuration
```
Debug_R26
```
(toolbar dropdown, do not select
```
Debug
```
)
Click Start/F5 — Automatic compilation → Artifacts copied to Addins directory → Launch Revit → Attach debugger
After Revit starts — Find the plugin button in the Ribbon tab, click it to trigger breakpoint debugging

Subsequent Customization

Vendor Information (
```
<Project Name>.addin
```
) — VendorId, VendorDescription, VendorEmail
About Page Information (
```
Models/AboutInfo.cs
```
) — GiteeUrl, Description
Add New Features — Refer to architecture.md

Add New Features

When users request to add new features to an existing project, read architecture.md to get complete code templates and rule constraints, and strictly follow the 6-step process from A to F:

Model →
```
Models/
```
directory
ViewModel →
```
ViewModels/
```
directory (partial class, inherits
```
ObservableObject
```
)
View →
```
Views/
```
directory (constructor injects ViewModel)

Command →

Commands/

directory (

[Transaction(TransactionMode.Manual)]

)

DI Registration →
```
Host.cs
```
(
```
AddTransient
```
)
Ribbon Button →
```
CreateRibbon
```
method in
```
Application.cs
```

Prohibited Actions

Do not use
```
Debug
```
/
```
Release
```
configurations, only use
```
Debug_R26
```
/
```
Release_R26
```
Do not manually
```
new
```
View or ViewModel, must obtain via
```
Host.GetService<T>()
```
Do not write business logic in View code-behind
Do not directly call
```
MessageBox
```
or operate
```
Window
```
in ViewModel
Do not hardcode configuration values, use
```
appsettings.json
```
+
```
IOptions<T>
```
Unless explicitly requested by the user, do not delete the sample About feature

saury-revit

NPX Install

Tags

SKILL.md Content (Chinese)

Saury Revit Project Creator

Workflow

Step 1: Interactive Confirmation of Project Configuration

Step 2: Check and Install .NET Environment

Step 3: Install Template

Step 4: Create Project

Step 5: Verify Project Structure

Step 6: Build Verification

Step 7: Inform User on How to Use

Debug Launch Configuration

Subsequent Customization

Add New Features

Prohibited Actions