Projekt is a tool for generating and managing F# project (
files, designed to be used with lightweight text editors. There are
two reasons for using
.fsproj files in your F# development:
Visual Studio and Xamarin Studio/Monodevelop both use this project format. If you are interested in working with others, or making your project easy to approach, then this is the way to go.
All intellisense tools for F# currently require an
.fsprojfile as a basis for describing the project. This isn't a fundamental limitation, but this is how FSharp.Compiler.Service currently works.
Projekt is currently available as a download from GitHub.com.
As this tool is designed to be integrated with editors, this documentation is intended for developers. To start using the tool, either:
- Clone the source and build with
- Download the latest release archive.
Projekt is intended to be invoked from the command line, and has a
number of 'subcommands', much like Git or
Paket. All commands except
version expect an
.fsproj file to be passed as the first argument,
and any that manipulate the F# source files and project file
referenced by the
.fsproj file also require a second argument. The
help text below lists the commands and the various command-specific
1: 2: 3: 4: 5: 6: 7: 8: 9: 10:
init subcommand. One possible usage is:
To add the file
MyFile.fs to the project
both are in the current directory), the following command should be
The order of compilation is important in F# projects. The previous
command would add the file
MyFile.fs as the last file in the
project. To move the file
MyFile.fs up by two, use:
Please see the Quick contributing guide in the README for contribution guidelines.
The library is available under MIT license, which allows modification and redistribution for both commercial and non-commercial purposes. For more information see the License file.