- Intro and getting started
- Build by convention
- Compile options
- Continuous integration
- Environment variables
- Ignore and exclude
- IDE Integration
tipi for the first time, a
TIPI_HOME_DIR will be created at:
- On Windows:
- On other platforms:
tipi will install dependencies, environment descriptions and tools for your environments in that location.
I case you want to specify an alternate location (if you don't have much space or no permission to write to that part of the disk)
you can set the environment variable
For example on Windows, in Powershell you can specify:
$env:TIPI_HOME_DIR = "D:\a\.tipi"
Note: tipi will re-download the requisite tools etc... on the next "first" launch.
tipi.build can be run on premise or in a private deployment. All users of that deployment need to specify
TIPI_ENDPOINT in their environment
tipi CLI to access the correct installation.
In non-interactive situation (a CI/CD job, other automated usages) it might be required to provide the
tipi CLI with
credentials to access private repositories or make use of the tipi subscription.
TIPI_REFRESH_TOKENare JWT tokens enabling
tipito get access to the tipi subscription.
TIPI_VAULT_PASSPHRASEhas to be supplied in situations where the user's Vault must be decrypted (ex. accessing private repos)
Tipi uses a json file which contains the required tools used by tipi to build projects (like
make). These tools are automatically downloaded and installed on demand by tipi at runtime before running projects build.
The contents of the file can be changed as per your needs for maximum usage flexibility setting the environment variable
The environment variable may point to:
- an absolute or relative file path
- an HTTP(s) url
The original json file can be found at https://github.com/tipi-build/distro/blob/master/distro.json
Below some examples of what you can set as
export TIPI_DISTRO_JSON= "~/projects/tipi/distro.json" - or - export TIPI_DISTRO_JSON= "/home/user/projects/tipi/distro.json" - or - export TIPI_DISTRO_JSON= "https://company.com/tipi/distro.json"
TIPI_DISTRO_JSON is a HTTP(s) url, tipi will download the file and check file integrity agains the value in the environment variable
When a customized
TIPI_DISTRO_JSON is downloaded via HTTP(s) tipi performs an integrity check by checking the
sha1sum of the downloaded file against the value of
export TIPI_DISTRO_JSON = "https://company/tipi/distro.json" export TIPI_DISTRO_JSON_SHA1 = "4eb777d088ea949709e9ea97bbc8c389a63856e2"
By default tipi only installs the subset of the build tools required to build remotely using the tipi.build cloud. For local builds you can install force the installation of the required tools locally.
export TIPI_DISTRO_MODE = "all" # "full" install - takes ~7gb in TIPI_HOME_DIR - or - export TIPI_DISTRO_MODE = "default" # "light" install for remote builds
Found an error or want to add more info? Write an issue or contribute changes to this documentation at tipi-build/docs on