Skip to main content

Import your codebase

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

Getting started​

To start importing a project:

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

Create a code project on Artemis

Import options​

Artemis provides three convenient ways to import your codebase:

Select the preferred code import option

Connects using GitHub's OAuth app authorization. This method provides broader access to your repositories and is managed through GitHub Apps, offering secure, token-free authentication.

Best for: Teams and individuals who want seamless GitHub integration with automatic repository discovery.

Option 2: Access Token​

Uses access keys for authentication. This option supports multiple authentication methods for different Git hosting services:

  • GitHub Personal Access Token (PAT)
  • Bitbucket API Token
  • Bitbucket App Password
  • SSH Key

Best for: Private repositories across different Git platforms or when you need fine-grained access control.

Option 3: Upload Archive​

Upload your project as a zip file directly from your local device.

Best for: Local projects not hosted on a Git platform or when you want to import a specific snapshot of your code.

The GitHub App integration provides the most seamless experience for importing repositories from GitHub.

Steps to import:​

  1. Select a GitHub account from the dropdown or click Add GitHub account to connect a new one.

    GitHub App integration options

  2. Install the Artemis GitHub App by clicking the Install GitHub App button. You'll be redirected to GitHub to authorize the app and select which repositories to grant access to.

  3. Grant repository access to Artemis — you can choose specific repositories or all repositories in your organization.

  4. Once connected, your available GitHub repositories will automatically appear in the import form.

    Select repository from GitHub App

  5. Select the desired repository from the list and click Import to import it into Artemis.

Benefits:​

  • Secure, token-free authentication
  • Automatic repository discovery
  • Easy management of repository access
  • Keeps your project synced for future updates or re-indexing

Method 2: Import via Access Token​

Use access tokens to import repositories from various Git hosting services including GitHub, Bitbucket, GitLab, and others.

Authentication for private repositories

If you are using a private Git repository, you need to configure an access token to authenticate Artemis. For public repositories, authentication is not required.

Setting up access tokens​

Before importing, you need to add an access token. The setup process varies depending on which authentication method you choose:

  1. Click Add access token from the authentication dropdown in the import form.

    Add access token options

  2. Select the key type that matches your Git hosting service and authentication preference:

    GitHub Personal Access Token (PAT)​

    The standard token for authenticating with public GitHub.com or GitHub Enterprise.

    • Use case: Authenticating with GitHub repositories
    • How it works: Token generated from GitHub's developer settings
    • Permissions: Can be scoped to specific repository access levels

    Bitbucket API Token​

    Used for authenticating with Bitbucket's REST API, typically for server-to-server integration or automation scripts.

    • Use case: Bitbucket server-to-server integration
    • How it works: Token for REST API access
    • Permissions: Broader API access for automation

    Bitbucket App Password​

    A more user-friendly Bitbucket token for granting specific permissions (like read/write to repos) without using your main account password.

    • Use case: Command-line Git operations with Bitbucket
    • How it works: More granular permissions without exposing main password
    • Permissions: Fine-grained control (read/write to specific repos)

    SSH Key​

    Generate a public/private key pair on your computer and register the public key with your Git hosting service.

    • Use case: Any Git service using SSH protocol (GitHub, Bitbucket, GitLab, etc.)
    • How it works: Public/private key cryptography
    • Permissions: Secure authentication without password-based tokens

  3. Provide a name for your token (e.g., "my-github-token") to identify it later.

  4. Paste the token value or public key in the token field.

  5. Test the connection to verify the credentials work correctly, then click Save.

Need help generating tokens?

For detailed instructions on creating access tokens for different platforms, see Using private code repositories.

Importing the repository​

Once your access token is configured:

  1. Select your access token from the dropdown list under Git authentication.

  2. Enter the Git repository URL (e.g., https://github.com/username/repository.git).

  3. (Optional) Specify a branch name and commit hash if you want to import a specific version.

  4. Click Import to complete the import process.

Method 3: Import via Archive Upload​

Upload a local code archive directly to Artemis.

Steps to import:​

  1. Prepare your code archive: Ensure your project is compressed as a .zip file.

  2. Click the Upload a zip file with your code button to browse and select your local code archive.

  3. Select your zip file from your computer.

  4. Click Import at the bottom of the page to complete the import.

Archive format

Currently, only .zip format is supported for archive uploads. Make sure your code is properly compressed before uploading.

Next steps​

After successfully importing your codebase:

Last updated on by neda.z