google-colab-cli README

README проекта с github.com/googlecolab/google-colab-cli. Одним файлом markdown: README.md.

Colab CLI

A command-line interface for Google Colab. Provision high-performance CPU, GPU, and TPU runtimes, execute local code, manage remote files, and orchestrate automated cloud pipelines — directly from your terminal.

Designed to support seamless developer productivity, headless automation, and AI agent integrations.

Demo

[!NOTE] Platform support: the Colab CLI currently supports Linux and macOS only. Windows is not supported at this time.

[!TIP] Looking for in-notebook, interactive agent-assisted coding instead of a terminal workflow? See the Colab MCP Server.


Key Features


Installation

Install the package using uv (recommended) or standard pip:

# Using uv (recommended)
uv tool install google-colab-cli

# Using pip
pip install google-colab-cli

Quick Start

Run a CPU-based VM runtime, execute some code, and clean up:

# 1. Provision a new session
colab new

# 2. Execute code from stdin
echo 'print("Hello from Google Colab!")' | colab exec

# 3. Stop and release the VM resource
colab stop

[!NOTE] When only one session is active, you can omit the -s, --session option; the CLI automatically knows it.


Command Index

Run colab <command> --help to view specific options, defaults, and detailed help.

Session Management

Command Description
colab new [-s NAME] [--gpu GPU] [--tpu TPU] [--high-mem] Allocate a new CPU, GPU, or TPU VM runtime (optionally high-RAM)
colab sessions List all active sessions currently active on the backend
colab status [-s NAME] Display hardware, machine shape, status, and local metadata for active sessions
colab restart-kernel [-s NAME] Restart the active session's Jupyter kernel
colab stop [-s NAME] Terminate a session VM and release its resources
colab url [-s NAME] [--open] Print or open a browser URL connecting to the active session

Execution

Command Description
colab run [--gpu GPU] [--tpu TPU] [--high-mem] [--keep] SCRIPT [ARGS...] Run a local script on a fresh VM, forwarding arguments, then release it
colab exec [-s NAME] [-f FILE] [--output-image PATH] Execute Python code from stdin, a local .py file, or a .ipynb notebook
colab repl [-s NAME] [--output-image PATH] Start an interactive Python REPL on the VM (exits cleanly on piped EOF)
colab ssh [-s NAME] [--proxy-mode] [-i KEY] [--gpu GPU] [--tpu TPU] [--high-mem] [-- CMD ...] Open an SSH shell to the runtime over WebSocket, run a one-shot remote command (-- CMD), or act as an OpenSSH ProxyCommand bridge for IDE remote-dev

File Operations

Command Description
colab ls [-s NAME] [PATH] List remote files on the VM
colab upload [-s NAME] LOCAL REMOTE Upload a local file to the VM filesystem
colab download [-s NAME] REMOTE LOCAL Download a remote file from the VM filesystem
colab rm [-s NAME] PATH Delete a remote file on the VM filesystem
colab edit [-s NAME] PATH Edit a remote file in-place using your local $EDITOR

Automation & Utilities

Command Description
colab auth [-s NAME] Authenticate the VM for GCP services (BigQuery, GCS, etc.)
colab drivemount [-s NAME] [PATH] Mount Google Drive on the VM (default: /content/drive)
colab install [-s NAME] [-r FILE | PKG...] Install packages on the VM using uv (falls back to pip)
colab log [-s NAME] [-n N] [-o FILE] View or export session history (.ipynb, .md, .txt, .jsonl)
colab usage Show account compute-unit usage rate and balance
colab pay Open the Colab subscription page to manage compute units
colab version Print the installed version of the CLI
colab update [--install] Check for a newer release (and optionally upgrade the CLI in place)

Global Options


Practical Examples

Accelerator Training with Checkpoint Retrieval

Provision an A100 GPU, install requirements, run a local training script, retrieve the resulting model weights, and terminate the VM:

colab new -s trainer --gpu A100
colab install -s trainer torch transformers
colab exec -s trainer -f train.py
colab download -s trainer checkpoints/model.bin ./model.bin
colab stop -s trainer

Workspace Notebook Execution with Drive Integration

Mount Google Drive, run a local notebook against the VM kernel (outputs are written back into report_output.ipynb), export a Markdown log of the execution, and clean up:

colab new -s analysis
colab drivemount -s analysis
colab exec -s analysis -f report.ipynb
colab log -s analysis -o execution_log.md
colab stop -s analysis

Usage Notes

Ephemeral Accelerator Jobs

Use colab run to run a local script on dedicated hardware without manual session lifecycle management. The CLI handles provisioning, script execution, and immediate VM teardown automatically:

# Run train.py on a T4 GPU and release the VM on completion
colab run --gpu T4 train.py

Shebang Execution Support

To execute a local file directly on a remote accelerator, place the colab run interpreter in the shebang line:

#!/usr/bin/env -S colab run --gpu L4 --keep
import torch

print("L4 GPU Available:", torch.cuda.is_available())
print("Device Name:", torch.cuda.get_device_name(0))

Make the script executable (chmod +x script.py) and run it: ./script.py. The --keep option tells the CLI to preserve the session VM on completion so you can re-execute or inspect logs.


Deep Dive Documentation

For comprehensive architectural overviews and deep-dives into specific CLI sub-systems, refer to the detailed documentation:

To view interactive walkthroughs of eleven real-world automated scenarios, check out the Demo Walkthroughs.


Contributing

Feedback and contributions are welcome! Please read CONTRIBUTING.md for details.


See Colab's Terms of Service and the Google Privacy Policy, which apply to usage of this CLI.

google-colab-cli (googlecolab/google-colab-cli)

Ищем в базе…

Что это такое?Интерфейс командной строки для Google Colab, который выделяет среды выполнения CPU, GPU или TPU, запускает локальный код и управляет удалёнными файлами, и всё это из терминала.
Это редактор блокнотов или инструмент для терминала?Это инструмент для терминала, а не редактор блокнотов. Вы управляете виртуальными машинами Colab с помощью команд вроде colab new, colab run и colab exec.
Как это запустить?Установите пакет через uv (рекомендуется) или pip, затем выполните colab new, чтобы выделить виртуальную машину с CPU, colab exec, чтобы запустить на ней код, и colab stop, чтобы её освободить.
Что нужно, прежде чем начать?Python с uv или pip и аккаунт Colab. Для ускорителей, таких как T4 и A100, а также для конфигураций с большим объёмом оперативной памяти нужна подписка Colab Pro или Pro+.
Работает ли это на Windows?Нет. CLI поддерживает только Linux и macOS, а Windows на данный момент не поддерживается.
Где на диске хранятся мои токены сессий?В файле ~/.config/colab-cli/sessions.json, а глобальные настройки находятся в ~/.config/colab-cli/settings.json. Расположение обоих файлов можно изменить или изолировать с помощью глобального флага --config.
Какие ускорители доступны?Среды выполнения CPU, GPU (T4, L4, G4, H100, A100) и TPU (v5e1, v6e1), а также необязательная конфигурация с большим объёмом оперативной памяти через флаг --high-mem на поддерживаемых ускорителях.
Какой самый быстрый способ запустить скрипт обучения на GPU?Используйте colab run с флагом ускорителя, например colab run --gpu A100 train.py с аргументами. Команда выделит новую виртуальную машину, запустит скрипт, загрузит выходные файлы и удалит машину. Добавьте --keep, чтобы сохранить виртуальную машину.
Можно ли отредактировать файл на виртуальной машине в своём редакторе?Да. colab edit открывает удалённый файл прямо на месте, используя ваш локальный $EDITOR.
Может ли моя IDE подключаться к среде выполнения для удалённой разработки?Да. colab ssh может работать как мост OpenSSH ProxyCommand, поэтому инструменты удалённой разработки в IDE могут подключаться к виртуальной машине Colab.
Есть ли вариант внутри блокнота для программирования с помощью агентов?В README указан отдельный Colab MCP Server для интерактивного программирования с помощью агентов внутри блокнота, а не в терминале.
Какие есть похожие проекты?skypilot, metaflow, agents-cli, vision_transformer, open-knowledge-format, agentbox, agentreach, jax
Автор
googlecolab
Размер
1.4 MB
Звёзды
2.5K
Обновлён
КоммитNov 18
Возраст
7 мес
Коммиты · 90 дней