ForSure Documentation
A prompting programming language for describing and documenting file structures in a clear and concise manner.
Learn about ForSure's AI capabilities that adapt to your coding style.
Introduction
ForSure is a prompting programming language designed to simplify projects by using a flat-file-like structured language/compiler/cli/converter system. It allows you to describe and document file structures in a clear and concise manner, similar to how you would write a Dockerfile for a container.
ForSure uses a simple, human-readable prompting syntax to represent directories, files, and their relationships, making it easy to understand and maintain project structures. Available as both a CLI tool and web application.
Why ForSure?
ForSure was created to solve the problem of documenting and sharing project structures in a standardized way. As a prompting programming language, it helps teams maintain consistency across projects and makes onboarding new developers easier.
Interactive Demo
Try ForSure's prompting language right in your browser. Edit the code below and see the generated file structure.
Interactive ForSure Demo
Edit the ForSure code and see the generated file structure
Key Features
A powerful prompting programming language that mimics the natural file system's hierarchy for intuitive organization.
Offers inline commenting and metadata association for better documentation.
Powerful command-line interface for generating and managing project structures from ForSure prompts.
Intuitive web interface for creating, managing, and sharing project structures without installing anything.
Facilitates file inclusion for reusable structures across projects.
Leverages artificial intelligence to optimize and enhance your project structures.
Basic Example
Here's a basic example of what a .forsure file looks like:
root:
# Main source code directory
- src:
- main.js { entry: true }
- utils:
# Utility scripts
- helpers.js
- date.js { timezone: "UTC" }
# Assets for front-end design
- assets:
- logo.svg
- css:
# Style sheets
- theme.css
# Documentation file
- README.mdThe example above shows how ForSure's prompting language represents a simple project structure with directories, files, comments, and attributes.
Getting Started
To start using ForSure, follow these steps:
Install ForSure
Clone the repository or install via npm to get started with ForSure.
# Install the CLI
npm install -g forsure-cli
# Or clone the repository
git clone https://github.com/elicharlese/ForSure.git
cd ForSureCreate your first ForSure file
Create a new .forsure file using our prompting language in any text editor.
root:
- src:
- index.js
- README.mdGenerate the file structure
Use the ForSure CLI or web app to generate the file structure from your .forsure file.
forsure generate my-first-project.forsure --output ./my-projectLearn the prompting syntax
Explore the ForSure prompting syntax to create more complex file structures.
Next Steps
Explore the documentation to learn more about ForSure: