`sbxm add`
sbxm add <github-clone-url> [options]sbxm add --local <git-dir> [--name <name>] [options]Accepted repository URLs are the SSH and HTTPS GitHub clone URLs shown by GitHub. The transport you pass is used for the host clone.
With --local, the repository whose Git directory is <git-dir> is added where it is, without a clone. Pass the .git of a working tree, a bare repository, or the .git file of a worktree or submodule; a working-tree directory is refused. A symlink or a .git file is resolved and the real path of the repository is recorded. The project ID is local/<name>, where the name is the directory name git clone would use unless --name gives another one. See Develop without GitHub.
Options
Section titled “Options”| Option | Meaning |
|---|---|
--local GIT_DIR |
Add the repository whose Git directory is GIT_DIR on this host instead of a GitHub repository |
--name NAME |
Name the project added with --local; defaults to the directory name |
--worktrees, -t N |
Set a target of 1–32 managed worktrees for the sandbox |
--detach BRANCH |
Start managed worktrees detached from a remote branch |
--git-user-name NAME |
Set the project commit name; provide it with email |
--git-user-email EMAIL |
Set the project commit email; provide it with name |
--lang LANG |
Choose the display language for this run |
--color MODE |
Choose auto, always, or never |
Without --detach, the first worktree follows the repository default branch; a repository added with --local starts from the branch the Git directory passed to it is on — for a worktree’s .git, that worktree’s branch — and a detached one needs --detach. More than one worktree in detached mode requires an explicit starting branch.
What it changes
Section titled “What it changes”It creates <repository>.project/ in the current directory, a host clone, project metadata, and a Dockerfile. It prints the project ID, sandbox name, and credential command. It does not build the sandbox. A repository added with --local gets no host clone and needs no credential.
The first interactive registration asks for display language and Git identity. Non-interactive use must provide both identity options or an already saved default.