Projects

Structure

Introduction

When you run the lean project-create or lean cloud pull commands, the CLI creates the basic files and folders most editors need to open your source code, provide autocomplete, and enable local debugging. This page documents exactly which files are created when you create a new local project with lean project-create or lean cloud pull.

Project Structure

New projects have the following structure:

.
├── .idea/
│   ├── misc.xml
│   ├── modules.xml
│   ├── <projectName>.iml
│   └── workspace.xml
├── .vscode/
│   ├── launch.json
│   └── settings.json
├── config.json
├── main.py (only generated by lean project-create)
└── research.ipynb (only generated by lean project-create)
.
├── .vscode/
│   └── launch.json
├── config.json
├── <projectName>.csproj
├── Main.cs (only generated by lean project-create)
└── Research.ipynb (only generated by lean project-create)

These files contain the following content:

FileContent
.idea / misc.xml,
.idea / modules.xml,
.idea / <projectName>.iml
These files contain PyCharm configuration so PyCharm can provide accurate autocomplete.
.idea / workspace.xmlThis file contains debug configuration to make debugging with PyCharm easier.
.vscode / launch.jsonThis file contains debug configuration to make debugging with VS Code easier.
.vscode / settings.jsonThis file contains VS Code configuration so that VS Code's Python and Pylance extensions can provide accurate autocomplete.
config.jsonThis file contains the project configuration of the created project.
main.pyThis file contains a basic Python algorithm to help you get started.
research.ipynbResearch.ipynbThis file contains a Python-based research notebook that can be opened in a Research Environment.
FileContent
.vscode / launch.jsonThis file contains debug configuration to make debugging with VS Code easier.
config.jsonThis file contains the project configuration of the created project.
<projectName>.csprojThis file contains project configuration which Visual Studio, Rider, and VS Code can read to provide accurate C# autocomplete.
Main.csThis file contains a basic C# algorithm to help you get started.
research.ipynbThis file contains a C#-based research notebook which can be opened in a research environment.

You can also see our Videos. You can also get in touch with us via Discord.

Did you find this page helpful?

Contribute to the documentation: