Download ForSure CLI

Get started with ForSure by installing our command-line interface tool.

ForSure CLI

Installation

Using npm (Recommended):

bash

npm install -g forsure-cli

Using yarn:

bash

yarn global add forsure-cli

Direct Download

Download the binary for your platform:

macOS (Intel/Apple Silicon) Windows (64-bit) Linux (64-bit)

All releases on GitHub

Verify Installation

After installation, verify that the ForSure CLI is working correctly by running:

bash

forsure --version

You should see the version number of the ForSure CLI that you installed.

Getting Started

Create your first ForSure file and generate a project structure:

1. Create a ForSure file:

forsure

1# project.forsure
2root:
3  - Type: Directory
4  - Path: ./
5  <description>
6  Root directory of the project.
7  </description>
8
9  - Type: File
10    - Name: README.md
11    <description>
12    Project documentation.
13    </description>
14
15  - Type: Directory
16    - Name: src/
17    <description>
18    Source code directory.
19    </description>

2. Generate the project structure:

bash

forsure generate project.forsure --output ./my-project

Quick Start Guide

System Requirements

Node.js

Node.js v14.0.0 or higher is required for the npm installation method.

Operating Systems

Windows 10/11, macOS 10.15+, or Linux (Ubuntu, Debian, CentOS, etc.)

Disk Space

Approximately 50MB of free disk space is required.

Next Steps

Read the Documentation

Learn how to use ForSure effectively

Explore CLI Commands

Discover all available CLI commands and options