Skip to content

Installation

Install the NestForge CLI, create an application, and run it locally.

This page is for application developers using NestForge to create and run a service.

If you want to work on the NestForge framework repository itself, use the framework developer setup in the contributing docs instead.

To create and run a NestForge app you need:

  • a stable Rust toolchain
  • cargo
  • git

Install the CLI from Cargo:

Terminal window
cargo install nestforge-cli

If you are developing against a local checkout of the framework, you can install the CLI from the repository workspace instead:

Terminal window
cargo install --path crates/nestforge-cli

After the CLI is installed, scaffold a new project:

Terminal window
nestforge new demo-api
cd demo-api
cargo run

The generated app starts with the normal Rust workflow:

Terminal window
cargo run

Typical local default for an HTTP service:

  • http://127.0.0.1:3000

NestForge is modular at the Cargo level. Enable only the feature sets your application needs. Common examples:

nestforge = { version = "1", features = ["config", "openapi"] }
nestforge = { version = "1", features = ["graphql"] }
nestforge = { version = "1", features = ["grpc", "microservices"] }

Depending on your stack, you may also need:

  • protoc for gRPC code generation
  • a reachable database for database-backed application code

Continue with CLI Workflow or go straight to Quick Start.