Skip to main content

Import your codebase

This page covers the steps to import a code repository into Artemis.

To start importing a project:

  • Go to the Projects tab on the left panel.
  • Click the New Project button on the top right.

See image below: Create a code project on Artemis

The options available for code import are:

  • GitHub App (recommended): import your GitHub repositories with secure, token-free authentication
  • Git repository: import a code project using Git
  • Archive: import a code project from your local device
  • Database: ingest code from a database

Select the preferred option from the form below: Select the preferred code import option

  • Install the Artemis GitHub App and sign in with your GitHub account.
  • Grant repository access to Artemis — you can choose specific repositories or all repositories in your organization.
  • Once connected, your available GitHub repositories will automatically appear in the import form.
  • Select the desired repository from the list and click Create Project to import it into Artemis.
  • This integration ensures secure, token-free authentication and keeps your project synced for future updates or re-indexing.

Import a Git repository​

Git keys on Artemis

If you are using a private Git repository, you need to configure a Git key to authenticate Artemis to import the repository. Read the documentation here: Using private code repositories. If you are using a public Git repository, you can continue without authentication.

  • Provide a name and (optional) description for the code project you are creating in Artemis.
  • Select a Git key from the dropdown list under Git authentication (only required for private repositories).
  • Enter the Git repository URL, and optionally specify a branch name and commit hash.
  • Click Create Project at the bottom of the page to finish importing.

Import a local folder​

  • Provide a name and (optional) description for the code project you are about to create in Artemis.
  • Click the Upload your code archive section to browse and select your local code project.
  • Click Create Project at the bottom of the page to complete the import.

Connect to a database to ingest data​

  • Provide a name and (optional) description for the code project you are about to create in Artemis.

  • Click Database as the import option.

  • Select the database you want to connect for your project.

  • Provide the following connection details:

    • Database host
    • Database port
    • Database name
    • Database username
    • Database password

  • If you are connecting to a PostgreSQL database, provide an SQL schema.

Next step:​

Go to Indexing your codebase to index your project.

Go to Optimise section to idetify target and optimise them.

Last updated on by diana