----------------------------------------------------------------------
This is the API documentation for the tugboat_cli library.
----------------------------------------------------------------------


## All functions

Functionality for creating and building Docker images.



----------------------------------------------------------------------
This is the CLI documentation for the package.
----------------------------------------------------------------------

## CLI: tugboat

```
Usage: tugboat [OPTIONS] COMMAND [ARGS]...

  Containerize R and Python projects with minimal configuration.

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  binderize  Prepare a GitHub repository for sharing via Binder.
  build      Build a Docker image from a Dockerfile and (optionally)...
  create     Identify all necessary software and dependencies for an R or...
```

### tugboat create

```
Usage: tugboat create [OPTIONS] [PROJECT]

  Identify all necessary software and dependencies for an R or Python project.
  Create a corresponding Docker image.

Options:
  --from TEXT                     Base image for the Docker image. Defaults to
                                  auto-detect: R projects use
                                  posit/r-base:{version}-noble; Python-only
                                  projects use python:{version}-slim.
  -e, --exclude PATTERN           File or directory to add to .dockerignore.
                                  May be repeated.
  --detect-r / --no-detect-r      Detect and install R and all dependencies in
                                  the image.  [default: detect-r]
  --detect-python / --no-detect-python
                                  Detect and install Python and all
                                  dependencies in the image.  [default:
                                  detect-python]
  --optimize-pak / --no-optimize-pak
                                  Use Posit Package Manager to install R
                                  binary packages. Disable as a first step
                                  when debugging R install errors.  [default:
                                  optimize-pak]
  -v, --verbose                   Print the generated Dockerfile before
                                  writing it.
  --help                          Show this message and exit.
```

### tugboat build

```
Usage: tugboat build [OPTIONS]

  Build a Docker image from a Dockerfile and (optionally) upload the image to
  DockerHub.

Options:
  -d, --dockerfile PATH      Path to the Dockerfile.  [default: Dockerfile]
  -n, --image-name TEXT      Name to assign to the built Docker image.
                             [default: tugboat]
  -t, --tag TEXT             Tag to assign to the built Docker image.
                             [default: latest]
  -p, --platform PLATFORM    Target platform (default: linux/amd64,
                             linux/arm64). May be repeated to build for
                             multiple platforms.
  --build-arg ARG            Extra argument forwarded verbatim to docker
                             buildx build. May be repeated.
  --build-context DIRECTORY  Build context directory. Defaults to the current
                             working directory.
  --push                     Push the built image to DockerHub after building.
  --dh-username TEXT         DockerHub username. Required when --push is set.
                             Also reads from DOCKERHUB_USERNAME.
  --dh-password TEXT         DockerHub password. Required when --push is set.
                             Also reads from DOCKERHUB_PASSWORD.
  -v, --verbose              Print the docker buildx build command before
                             executing it.
  --help                     Show this message and exit.
```

### tugboat binderize

```
Usage: tugboat binderize [OPTIONS] [PROJECT]

  Prepare a GitHub repository for sharing via Binder.

Options:
  --detect-r / --no-detect-r      Detect and install R and all dependencies in
                                  the image.  [default: detect-r]
  --detect-python / --no-detect-python
                                  Detect and install Python and all
                                  dependencies in the image.  [default:
                                  detect-python]
  -b, --branch TEXT               Repository branch to point the Binder launch
                                  URL at.  [default: main]
  -u, --urlpath TEXT              URL path Binder opens on launch.  [default:
                                  rstudio]
  --add-readme-badge / --no-add-readme-badge
                                  Insert the Binder launch badge into
                                  README.md. When disabled, the badge snippet
                                  is copied to the clipboard instead.
                                  [default: add-readme-badge]
  --overwrite / --no-overwrite    Whether to overwrite an existing
                                  .binder/Dockerfile.  [default: overwrite]
  --optimize-pak / --no-optimize-pak
                                  Use Posit Package Manager to install R
                                  binary packages. Disable as a first step
                                  when debugging R install errors.  [default:
                                  optimize-pak]
  -v, --verbose                   Print the generated Binder Dockerfile before
                                  writing it.
  --help                          Show this message and exit.
```