Uploading sources with the territory.dev CLI client

Watch a video walkthrough:

1. Prepare your repository

For C/C++ Projects

Clone your repository and generate compile_commands.json. See examples of how this can be generated here.

For Go Projects

Clone your repository and ensure your Go module is properly initialized:

go mod download

For Python Projects

If you created a virtualenv for your project, we recommend you install and run territory with it activated.

2. Add a new repo in the territory.dev interface

Go to settings,

find the "Add" button under Repositories,

enter repository details, choose the "Uploaded" option, and select the appropriate language (C/C++ or Go),

create the new repository by clicking "Save".

3. Install the client

Install with pip within a Python virtualenv:

pip install territory

4. Run the upload

For C/C++ Projects

In the directory containing compile_commands.json run:

territory upload --repo-id $YOUR_REPOSITORY_ID -l c

For Go and Python Projects

In your git repository run:

# Go:
territory upload --repo-id $YOUR_REPOSITORY_ID -l go

# Python:
territory upload --repo-id $YOUR_REPOSITORY_ID -l python

We will scan the repo for modules, package parse results and send the code for indexing.

The specific command containing the repository ID can be found in repository settings under "Recent builds".

First time you use the client, we will open the web browser and you will be asked to authenticate the client in the web app.

Once the upload finishes, indexing will start.

Non-interactive authentication

In case you need to run the upload in an environment where the browser authentication flow is not suitable (e.g. a CI build), you can provide the necessary token manually.

1. In "Settings" go to to Upload tokens.
2. Create a new token and save its text to a file.
3. Point the CLI to the file by adding the --upload-token-path, e.g.:

   territory upload \
       --upload-token-path /path/to/token \
       --repo-id $YOUR_REPOSITORY_ID