Git 連携

Novita Sandbox は、clone、branch の作成、commit、pull、push、remote の管理、Git の設定など、一般的なリポジトリワークフロー向けの sandbox.git ヘルパーを提供します。

認証と identity

インライン認証情報

プライベート HTTPS リポジトリでは、push、pull、clone などの操作に、ユーザー名とパスワード/token の両方を直接渡します。

import { Sandbox } from 'novita-sandbox'

const sandbox = await Sandbox.create()

await sandbox.git.push(repoPath, {
  username: process.env.GIT_USERNAME,
  password: process.env.GIT_TOKEN,
})

await sandbox.git.pull(repoPath, {
  username: process.env.GIT_USERNAME,
  password: process.env.GIT_TOKEN,
})

from novita_sandbox.core import Sandbox
import os

sandbox = Sandbox.create()

sandbox.git.push(
    repo_path,
    username=os.environ.get("GIT_USERNAME"),
    password=os.environ.get("GIT_TOKEN"),
)

sandbox.git.pull(
    repo_path,
    username=os.environ.get("GIT_USERNAME"),
    password=os.environ.get("GIT_TOKEN"),
)

Git credential helper で一度だけ認証する

JavaScript では dangerouslyAuthenticate()、Python では dangerously_authenticate() を使用して、sandbox の credential helper 内に認証情報を保存できます。

認証情報は sandbox 内のディスクに書き込まれ、sandbox へのアクセス権を持つものは誰でも読み取ることができます。

認証情報は、デフォルトで GitHub 用に保存することも、カスタム HTTPS ホスト用に保存することもできます。

await sandbox.git.dangerouslyAuthenticate({
  username: process.env.GIT_USERNAME,
  password: process.env.GIT_TOKEN,
})

await sandbox.git.dangerouslyAuthenticate({
  username: process.env.GIT_USERNAME,
  password: process.env.GIT_TOKEN,
  host: 'git.example.com',
  protocol: 'https',
})

await sandbox.git.clone('https://git.example.com/org/repo.git', {
  path: '/home/user/repo',
})

await sandbox.git.push('/home/user/repo')

sandbox.git.dangerously_authenticate(
    username=os.environ.get("GIT_USERNAME"),
    password=os.environ.get("GIT_TOKEN"),
)

sandbox.git.dangerously_authenticate(
    username=os.environ.get("GIT_USERNAME"),
    password=os.environ.get("GIT_TOKEN"),
    host="git.example.com",
    protocol="https",
)

sandbox.git.clone(
    "https://git.example.com/org/repo.git",
    path="/home/user/repo",
)

sandbox.git.push("/home/user/repo")

remote URL に認証情報を保持する

デフォルトでは、clone 後に認証情報は remote URL から削除されます。.git/config に保持するには、dangerouslyStoreCredentials: true（JS）または dangerously_store_credentials=True（Python）を設定します。

remote URL に保持された認証情報は repo config に残り、sandbox プロセスから読み取ることができます。

await sandbox.git.clone('https://git.example.com/org/repo.git', {
  path: '/home/user/repo',
  username: process.env.GIT_USERNAME,
  password: process.env.GIT_TOKEN,
})

await sandbox.git.clone('https://git.example.com/org/repo.git', {
  path: '/home/user/repo',
  username: process.env.GIT_USERNAME,
  password: process.env.GIT_TOKEN,
  dangerouslyStoreCredentials: true,
})

sandbox.git.clone(
    "https://git.example.com/org/repo.git",
    path="/home/user/repo",
    username=os.environ.get("GIT_USERNAME"),
    password=os.environ.get("GIT_TOKEN"),
)

sandbox.git.clone(
    "https://git.example.com/org/repo.git",
    path="/home/user/repo",
    username=os.environ.get("GIT_USERNAME"),
    password=os.environ.get("GIT_TOKEN"),
    dangerously_store_credentials=True,
)

commit identity を設定する

configureUser（JS）または configure_user（Python）を使用して、commit author の詳細をグローバルまたはリポジトリ単位で設定できます。

await sandbox.git.configureUser('Novita Bot', 'bot@example.com')

await sandbox.git.configureUser('Novita Bot', 'bot@example.com', {
  scope: 'local',
  path: repoPath,
})

sandbox.git.configure_user("Novita Bot", "bot@example.com")

sandbox.git.configure_user(
    "Novita Bot",
    "bot@example.com",
    scope="local",
    path=repo_path,
)

リポジトリを clone する

サポートされる clone オプションには、宛先パス、branch の選択、depth、username、password、credential-storage の挙動が含まれます。

await sandbox.git.clone(repoUrl, {
  path: repoPath,
})

await sandbox.git.clone(repoUrl, {
  path: repoPath,
  branch: 'main',
})

await sandbox.git.clone(repoUrl, {
  path: repoPath,
  depth: 1,
})

sandbox.git.clone(repo_url, path=repo_path)

sandbox.git.clone(repo_url, path=repo_path, branch="main")

sandbox.git.clone(repo_url, path=repo_path, depth=1)

リポジトリの status と branch を確認する

status() を使用して、現在の branch、ahead/behind カウント、file status を確認できます。 branches() を使用して、branch 一覧と現在の branch を取得できます。

const status = await sandbox.git.status(repoPath)
console.log(status.currentBranch)
console.log(status.ahead)
console.log(status.behind)
console.log(status.fileStatus)

const branches = await sandbox.git.branches(repoPath)
console.log(branches.currentBranch)
console.log(branches.branches)

status = sandbox.git.status(repo_path)
print(status.current_branch)
print(status.ahead)
print(status.behind)
print(status.file_status)

branches = sandbox.git.branches(repo_path)
print(branches.current_branch)
print(branches.branches)

branch を作成、切り替え、削除する

await sandbox.git.createBranch(repoPath, 'feature/new-docs')

await sandbox.git.checkoutBranch(repoPath, 'main')

await sandbox.git.deleteBranch(repoPath, 'feature/old-docs')

await sandbox.git.deleteBranch(repoPath, 'feature/stale-docs', {
  force: true,
})

sandbox.git.create_branch(repo_path, "feature/new-docs")

sandbox.git.checkout_branch(repo_path, "main")

sandbox.git.delete_branch(repo_path, "feature/old-docs")

sandbox.git.delete_branch(
    repo_path,
    "feature/stale-docs",
    force=True,
)

変更を stage して commit する

add を使用して、すべての変更または選択したファイルを stage できます。 commit を使用して、commit を作成できます。オプションには、カスタム author name、author email、empty commit が含まれます。

await sandbox.git.add(repoPath)

await sandbox.git.commit(repoPath, 'Initial commit')

await sandbox.git.add(repoPath, {
  files: ['README.md', 'src/index.ts'],
})

await sandbox.git.commit(repoPath, 'Docs sync', {
  authorName: 'Novita Bot',
  authorEmail: 'bot@example.com',
  allowEmpty: true,
})

sandbox.git.add(repo_path)

sandbox.git.commit(repo_path, "Initial commit")

sandbox.git.add(
    repo_path,
    files=["README.md", "src/index.ts"],
)

sandbox.git.commit(
    repo_path,
    "Docs sync",
    author_name="Novita Bot",
    author_email="bot@example.com",
    allow_empty=True,
)

pull と push

push と pull は、デフォルトで設定済みの upstream を使用できます。remote、branch、upstream 設定を指定することもできます。

await sandbox.git.push(repoPath)

await sandbox.git.pull(repoPath)

await sandbox.git.push(repoPath, {
  remote: 'origin',
  branch: 'main',
  setUpstream: true,
})

await sandbox.git.pull(repoPath, {
  remote: 'origin',
  branch: 'main',
})

sandbox.git.push(repo_path)

sandbox.git.pull(repo_path)

sandbox.git.push(
    repo_path,
    remote="origin",
    branch="main",
    set_upstream=True,
)

sandbox.git.pull(
    repo_path,
    remote="origin",
    branch="main",
)

remote を管理する

remoteAdd（JS）または remote_add（Python）を使用して、remote を追加したり、追加後に必要に応じて fetch したり、既存の remote を上書きしたりできます。

await sandbox.git.remoteAdd(repoPath, 'origin', repoUrl)

await sandbox.git.remoteAdd(repoPath, 'origin', repoUrl, {
  fetch: true,
})

await sandbox.git.remoteAdd(repoPath, 'origin', repoUrl, {
  overwrite: true,
})

sandbox.git.remote_add(repo_path, "origin", repo_url)

sandbox.git.remote_add(
    repo_path,
    "origin",
    repo_url,
    fetch=True,
)

sandbox.git.remote_add(
    repo_path,
    "origin",
    repo_url,
    overwrite=True,
)

Git 設定

setConfig / set_config および getConfig / get_config を使用して、Git 設定をグローバルまたはリポジトリ単位で管理できます。

await sandbox.git.setConfig('pull.rebase', 'false')

const value = await sandbox.git.getConfig('pull.rebase')

await sandbox.git.setConfig('pull.rebase', 'false', {
  scope: 'local',
  path: repoPath,
})

const localValue = await sandbox.git.getConfig('pull.rebase', {
  scope: 'local',
  path: repoPath,
})

sandbox.git.set_config("pull.rebase", "false")

value = sandbox.git.get_config("pull.rebase")

sandbox.git.set_config(
    "pull.rebase",
    "false",
    scope="local",
    path=repo_path,
)

local_value = sandbox.git.get_config(
    "pull.rebase",
    scope="local",
    path=repo_path,
)

Get started

Model APIs

Agent Sandbox

GPUs

Observability

Resources

認証と identity

インライン認証情報

Git credential helper で一度だけ認証する

remote URL に認証情報を保持する

commit identity を設定する

リポジトリを clone する

リポジトリの status と branch を確認する

branch を作成、切り替え、削除する

変更を stage して commit する

pull と push

remote を管理する

Git 設定

​認証と identity

​インライン認証情報

​Git credential helper で一度だけ認証する

​remote URL に認証情報を保持する

​commit identity を設定する

​リポジトリを clone する

​リポジトリの status と branch を確認する

​branch を作成、切り替え、削除する

​変更を stage して commit する

​pull と push

​remote を管理する

​Git 設定

認証と identity

インライン認証情報

Git credential helper で一度だけ認証する

remote URL に認証情報を保持する

commit identity を設定する

リポジトリを clone する

リポジトリの status と branch を確認する

branch を作成、切り替え、削除する

変更を stage して commit する

pull と push

remote を管理する

Git 設定