Skip to content

Commit 3e9183b

Browse files
committed
tidy docstring
1 parent d7f9c7b commit 3e9183b

File tree

1 file changed

+2
-30
lines changed

1 file changed

+2
-30
lines changed

airbyte_cdk/cli/airbyte_cdk/_image.py

Lines changed: 2 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,7 @@
11
"""Airbyte CDK 'image' commands.
22
3-
The `airbyte-cdk` command provides a simplified way to build connector Docker images without requiring the full Airbyte CI pipeline.
4-
5-
```bash
6-
pip install airbyte-cdk
7-
8-
pipx run airbyte-cdk image [arguments]
9-
```
10-
11-
12-
```bash
13-
airbyte-cdk image build /path/to/connector
14-
15-
airbyte-cdk image build /path/to/connector --tag custom_tag
16-
17-
airbyte-cdk image build /path/to/connector --no-verify
18-
19-
airbyte-cdk image build /path/to/connector --verbose
20-
```
21-
22-
23-
- `connector_dir`: Path to the connector directory (required)
24-
- `--tag`: Tag to apply to the built image (default: "dev")
25-
- `--no-verify`: Skip verification of the built image
26-
- `--verbose`, `-v`: Enable verbose logging
27-
28-
29-
The command reads the connector's metadata from the `metadata.yaml` file, builds a Docker image using the connector's Dockerfile, and verifies the image by running the `spec` command. The image is tagged according to the repository name specified in the metadata and the provided tag.
30-
31-
This command is designed to be a simpler alternative to the `airbyte-ci build` command, using Docker directly on the host machine instead of Dagger.
3+
The `airbyte-cdk image build` command provides a simple way to work with Airbyte
4+
connector images.
325
"""
336

347
import sys
@@ -41,7 +14,6 @@
4114
from airbyte_cdk.utils.docker import (
4215
build_connector_image,
4316
verify_docker_installation,
44-
verify_image,
4517
)
4618

4719

0 commit comments

Comments
 (0)