GitHub Blogs Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage
Edit page

Getting Started

Install ArtiVC

Install from Release Page

Download the latest ArtiVC in the release page

Install by homebrew

brew tap infuseai/artivc 
brew install artivc


Here we describe how to configure credentials to access the remote backend. The principle of ArtiVC is “Use your tool’s config”. This allows you to access among the toolchains painlessly.

No configuration required
  1. Configure the ~/.ssh/config
    Host myserver
       HostName myserver.hosts
       User myname
       IdentityFile ~/.ssh/id_ed25519
  2. Check if you can access the SSH server successfully
    ssh myserver

For more information, please see the Remote Filesystem (SSH) backend

  1. Install the AWS CLI
  2. Configure the AWS CLI
    aws configure
  3. Check current config
    aws configure list      

For more information, please see the AWS S3 backend

  1. Install the glcoud CLI
  2. Login the application default credential
    gcloud auth application-default login  
  3. Check the current credential is available
    gcloud auth application-default print-access-token 

For more information, please see the Google Cloud Storage backend

  1. Install the Azure CLI
  2. Login the Azure CLI
    az login
  3. Check the login status
    az account show

For more information, please see the Azure Blob Storage

Quick Start

Push data

  1. Prepare your data. We put data in the folder /tmp/artivc/workspace

    mkdir -p /tmp/artivc/workspace
    cd /tmp/artivc/workspace

    put the first version of data

    echo a > a
    echo b > b
    echo c > c
  2. Select a folder as the repository. Here we use /tmp/artivc/repo

    mkdir -p /tmp/artivc/repo
  3. Init the workspace

    # in /tmp/artivc/workspace
    avc init /tmp/artivc/repo
    # in /tmp/artivc/workspace
    avc init <host>:path/to/repo
    # in /tmp/artivc/workspace
    avc init s3://<bucket>/path/to/repo
    # in /tmp/artivc/workspace
    avc init gs://<bucket>/path/to/repo
    # in /tmp/artivc/workspace
    avc init https://<storageaccount><container>/path/to/repo
  4. Push the data

    avc push
  5. See the commit log

    avc log
  6. Add more data to your repository

    echo "hello" > hello
    avc status

    push to the remote

    avc push
  7. Tag a version

    avc tag v0.1.0

    See the log

    avc log

Clone data from existing repository

  1. Go to the folder to clone repository

    cd /tmp/artivc/
    avc clone /tmp/artivc/repo another-workspace   
    cd /tmp/artivc/
    avc clone <host>:path/to/repo
    cd /tmp/artivc/
    avc clone s3://<bucket>/path/to/repo
    cd /tmp/artivc/
    avc clone gs://<bucket>/path/to/repo
    cd /tmp/artivc/
    avc clone https://<storageaccount><container>/path/to/repo

    Then the workspace is created, and the data is downloaded.

  2. See the commit log

    cd another-workspace/
    avc log

Download data

  1. Download the latest version

    avc get -o /tmp/artivc/dl-latest /tmp/artivc/repo
    avc get -o /tmp/artivc/dl-latest <host>:path/to/repo
    avc get -o /tmp/artivc/dl-latest s3://<bucket>/path/to/repo
    avc get -o /tmp/artivc/dl-latest gs://<bucket>/path/to/repo
    avc get -o /tmp/artivc/dl-latest https://<storageaccount><container>/path/to/repo

    check the content

    ls /tmp/artivc/dl-latest
  2. Or download the specific version

    avc get -o /tmp/artivc/dl-v0.1.0 /tmp/artivc/repo@v0.1.0
    avc get -o /tmp/artivc/dl-v0.1.0 <host>:path/to/repo@v0.1.0
    avc get -o /tmp/artivc/dl-v0.1.0 s3://<bucket>/path/to/repo@v0.1.0
    avc get -o /tmp/artivc/dl-v0.1.0 gs://<bucket>/path/to/repo@v0.1.0
    avc get -o /tmp/artivc/dl-v0.1.0 https://<storageaccount><container>/path/to/repo@v0.1.0

    check the content

    ls /tmp/artivc/dl-v0.1.0