Create Project


Let's make our next cross platform project a success with Bit.Boilerplate.

How it works
  1. Tell the assistant about your app, or pick the options below. Either way, the command stays ready to copy.
  2. Copy it and paste it into a terminal. If something needs installing with administrator rights, Windows asks once.
  3. The bit new command installs what this machine is missing, creates the project, adds its first EF Core migration, trusts the folder, installs the VS Code extensions the project recommends and opens it in VS Code.
  4. Use any AI assistant you like: the project comes fully configured for Claude Code, GitHub Copilot, Codex, Gemini CLI and Cursor.

The platforms you tick only decide what is set up on this machine now; every project has the web, Android, iOS, Windows and macOS apps. New to the bit CLI? Getting started shows how to install it with the .NET SDK.


Describe your project

Tell the assistant what you're building, in your own words. It fills in the options below and asks a question or two so the project fits better. You don't have to answer them: copy the command whenever you like, and go on with your day.

Adds --realProject, which keeps the project's containers running between runs so debugging starts fast, and switches to PostgreSQL, S3, Redis and SignalR (AI Chatbot) wherever you haven't picked something else.


bit new MyFirstProject --github-repo --yes

Paste it into a terminal, then go on with your day. No bit CLI yet? Run dotnet tool install --global Bit.Cli --prerelease first, or put dnx Bit.Cli --prerelease -- in place of bit.


Name

bit new MyFirstProject 

It is required to specify a name for your project.
Platforms to set up on this machine now

--platforms web 
This only decides what bit new installs and builds on this machine right now. Every project has the web, Android, iOS, Windows and macOS apps.

The web app is always set up. Ticking any native app builds the whole solution, which needs several GB of extra build tools and makes the first build minutes longer. Add one any time later from the project folder, e.g. bit setup --platforms android.
Open in

--ide code 
By default bit new opens the project in VS Code, installs the extensions the project recommends (C# Dev Kit, Copilot, Claude Code and more), and trusts the folder, so it opens without prompts. If VS Code is missing, it's installed for you.
Server Database

--database Sqlite 
The API project requires an Entity Framework Core DbContext for tables such as ASP.NET Core Identity.

Supported options include SqlServer, PostgreSQL, MySQL and Other.

For the default SQLite option, we'd recommend installing sqlite package for Visual Studio and Visual Studio Code.
Multi-tenancy
--multitenant 

You can experience the Multi-tenancy feature instantly by logging into adminpanel.bitplatform.dev using [email protected] (Password: 123456). This gives you access to a demo tenant ("Store") where you can explore the Dashboard, Products, and Categories.

Alternatively, you can sign in using your regular Google/Gmail account to automatically create your own isolated tenant. Once inside your personal tenant, you will also gain access to advanced Identity Management features, including User and Role administration pages.

Note: The Global Tenant Administration page is exclusive to Global Administrators. To explore global management features, we recommend creating your project following this tutorial and running it locally. You can then log in using [email protected] (Password: 123456) to access full global admin privileges.

File Storage
--filesStorage Local 
The API project includes an Attachment Controller responsible for handling user images, including resizing and saving them in the WebP format using FluentStorage

Local option stores files on local hard drive.
Pipeline

--pipeline GitHub 

Ensure a rapid and reliable deployment by utilizing a pipeline. By selecting GitHub, CI/ CD pipelines will be set up using Github Actions.

Adds --github-repo. The bit new command installs the GitHub CLI if it's missing, and opens GitHub in your browser when you need to sign in.

Redis

--redis false 

bit Boilerplate handles most of your scalability requirements using Redis:

  • Hybrid (In-memory + Redis) caching with FusionCache
  • Background job processing for Hangfire
  • SignalR backplane (Azure SignalR Service is also pre-configured)
  • Distributed locking
If Redis integration is disabled:
  • In-memory caching will be used instead of hybrid caching
  • Background jobs will be persisted in the database (significantly slower)
In production, You may not scale out the application without addressing distributed locking and SignalR scale out concerns.

Aspire

Aspire helps you publish your project not only on Azure, AWS, and Kubernetes, but also on a simple Linux VPS running a basic Docker Compose setup, automatically building the database, API projects, and more.

In the Bit Boilerplate, .NET Aspire automatically provisions Redis, a database, file storage (Azure Blob Storage or S3), a test SMTP server, Keycloak, and Dev Tunnels for you!
--aspire 

Aspire helps you build, test, and deploy distributed applications with ease. Learn more at ASP.NET Core Aspire. It runs those resources in containers, so bit new installs the Aspire CLI, and offers Docker, when they're missing.

API

--api Integrated 
Select the API mode that best aligns with your specific requirements.

Easily debug and deploy Server.Web projects that serves restful API services, SSR, Blazor Server, Blazor Auto and pre-rendering.

Integrated API architecture diagram
Module

--module None 
Use this parameter to initialize the project with a module. The two available options are Admin Panel and Sales.
Captcha

--captcha None 

By setting this parameter to None, CAPTCHA won't be added to the project.
Push Notification (Native and Web Push)

--notification 
Setting this parameter to True enables native push notification using firebase and APN for Androiod, iOS and macOS apps alongside with Web Push for Web Browsers.
Sample

--sample false 
Use this parameter to initialize the project with a sample pages. Checkout demo sample at Todo.
Sentry

--sentry false 
Adding --sentry to the bit new command allows you to capture errors, crashes, and analytics data seamlessly across all supported platforms.
AppInsights

--appInsights false 
To enable Azure Application Insights for both server and client-side applications (including web), set the appinsights parameter to true. This option will configure the application to store logs such as errors and informational messages.
SignalR

--signalR false 
Enabling this parameter will include sample code for SignalR, which can be used to implement real-time functionalities, such as chat, in your Blazor project.

Note:
Disabling this feature will affect AI Chatbot features.
Offline Database

--offlineDb false 
Setting this parameter to True enables SQLite and Entity Framework Core, allowing for the development of an offline-capable cross platform application.

Warning: It is advisable to use this option only when necessary, as integrating Entity Framework Core can increase application size and potentially reduce startup performance.
Cloudflare

--cloudflare 
Integrating Cloudflare and placing your backend behind the Cloudflare CDN will significantly enhance the app's performance while reducing server load.
Google Ads

--ads false 
Helps you earn money by displaying reward-based Google ads. Demo
bit Brouter

--brouter false 
bit Brouter replaces Blazor's built-in Router and brings the powerful routing features that developers enjoy in Vue.js, React and Angular to the Blazor ecosystem: nested routing, async route guards, data loaders, keep-alive pages that preserve their state across navigation, named and typed routes, and animated view transitions.

It stays a drop-in replacement, so your existing @page routes, layouts and authorization keep working unchanged while you opt into the advanced features where you need them.
Theme

--theme Fluent2 
The design system the app's UI ships with, powered by bit BlazorUI theming. Fluent 2 is the default; Fluent, Cupertino and Material are also available, and all of them come with light and dark modes out of the box.