Documentation & Usage

Quick Start & CLI Reference

Everything you need to configure and run git2iris against InterSystems IRIS.

Local Folder Sync & Compile

Run git2iris against a local directory containing ObjectScript files (.cls, .mac, .inc, .dfi, .gbl):

./git2iris \
  -dir ./examples/sample_cls \
  -endpoint http://192.168.1.200:52773/api/atelier \
  -user _SYSTEM \
  -pass intersystems \
  -ns USER

GitLab API Sync & Compile

Sync an entire GitLab repository directly into InterSystems IRIS:

./git2iris \
  -gitlab-url https://gitlab.com \
  -gitlab-project ron-sween/xsiri \
  -gitlab-token glpat-xxxxxxxxxxxx \
  -gitlab-ref main \
  -endpoint http://192.168.1.200:52773/api/atelier \
  -user _SYSTEM \
  -pass intersystems \
  -ns USER

To sync a specific subfolder or path within the GitLab repository, use the -gitlab-path flag:

./git2iris \
  -gitlab-url https://gitlab.com \
  -gitlab-project ron-sween/xsiri \
  -gitlab-token glpat-xxxxxxxxxxxx \
  -gitlab-ref main \
  -gitlab-path purple-int/src \
  -endpoint http://192.168.1.200:52773/api/atelier \
  -user _SYSTEM \
  -pass intersystems \
  -ns USER

Command-Line Options

FlagDefaultDescription
-endpoint, -atelier-urlhttp://192.168.1.200:52773/api/atelierInterSystems Atelier REST API URL
-user_SYSTEMIRIS Atelier username
-passintersystemsIRIS Atelier password
-nsUSERTarget IRIS namespace
-dir, -d""Local directory containing ObjectScript files
-gitlab-urlhttps://gitlab.comBase URL of GitLab instance
-gitlab-project""GitLab Project ID (e.g. 12345) or path (group/repo)
-gitlab-token$GITLAB_TOKENPersonal/Job access token for GitLab API
-gitlab-refmainGit branch, tag, or commit SHA
-gitlab-path""Optional subpath inside repository to scan
-compiletrueCompile uploaded documents on IRIS
-compile-flagsckAtelier compilation flags (e.g., ck, cuk, d)
-concurrency4Number of parallel upload workers
-dry-runfalsePreview document mappings without uploading
-vfalseEnable verbose output
-versionfalseDisplay version information