Notebook Command

The notebook command launches a Jupyter Lab instance with a pre-configured notebook for exploring your codebase.

Usage

gs notebook [--background]

Options

• --background: Run Jupyter Lab in the background (default: false)

By default, Jupyter Lab runs in the foreground, making it easy to stop with Ctrl+C. Use --background if you want to run it in the background.

What it Does

This will:

1. Create a Python virtual environment in .codegen/.venv if it doesn't exist
2. Install required packages (codegen and jupyterlab)
3. Create a starter notebook in .codegen/jupyter/tmp.ipynb
4. Launch Jupyter Lab with the notebook open

The notebook comes pre-configured with:

from graph_sitter import Codebase
 
# Initialize codebase
codebase = Codebase('../../')

Directory Structure

After running gs notebook, your repository will have this structure:

.codegen/
├── .venv/          # Virtual environment for this project
├── jupyter/        # Jupyter notebooks
│   └── tmp.ipynb   # Pre-configured notebook
└── config.toml     # Project configuration

Examples

# Run Jupyter in the foreground (default)
gs notebook
 
# Run Jupyter in the background
gs notebook --background
 
# Initialize a new repository and launch notebook
gs init && gs notebook