Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The Wave CLI is a convenient wrapper around the Wave API.

You can compose Wave CLI with other commands. The CLI returns the URL of the container build on `stdout` in the following format:

```
```console
wave.seqera.io/wt/xxxxxxxxxxxx/wave/build:xxxxxxxxxxxxxxxx
```

Expand Down
16 changes: 8 additions & 8 deletions docs/cli/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,35 +16,35 @@ To self-install the latest Wave release from GitHub:

1. Move the executable from your downloads folder to a location in your `PATH`, such as `~/bin`. For example:

```
```bash
mv wave-cli-0.8.0-macos-x86_64 ~/bin/wave
```

1. Ensure that the executable permission is set. For example:

```
```bash
chmod u+x ~/bin/wave
```

1. Verify that you can build containers with Wave:

1. Create a basic `Dockerfile`:

```
```Dockerfile
cat << EOF > ./Dockerfile
FROM busybox:latest
EOF
```

1. Use the CLI to build the container:

```
```bash
wave -f Dockerfile
```

Example output:

```
```console
wave.seqera.io/wt/xxxxxxxxxxxx/wave/build:xxxxxxxxxxxxxxxx
```

Expand All @@ -62,21 +62,21 @@ To install the latest version with [Homebrew]:

1. Create a basic `Dockerfile`:

```
```Dockerfile
cat << EOF > ./Dockerfile
FROM busybox:latest
EOF
```

1. Use the CLI to build the container:

```
```bash
wave -f Dockerfile
```

Example output:

```
```console
wave.seqera.io/wt/xxxxxxxxxxxx/wave/build:xxxxxxxxxxxxxxxx
```

Expand Down
24 changes: 12 additions & 12 deletions docs/cli/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ The following arguments are used for a directory build:

Create a new context directory:

```
```bash
mkdir -p new-layer/usr/local/bin
printf 'echo Hello world!' > new-layer/usr/local/bin/hello.sh
chmod +x new-layer/usr/local/bin/hello.sh
```

Use the CLI to build the image and run the result with Docker:

```
```bash
docker run $(wave -i alpine --layer new-layer) sh -c hello.sh
```
</details>
Expand All @@ -64,7 +64,7 @@ Conda builds support the following arguments:

In the following example, a container with the `samtools` and `bamtools` packages is built:

```
```bash
wave \
--conda-package bamtools=2.5.2 \
--conda-package samtools=1.17
Expand Down Expand Up @@ -92,7 +92,7 @@ Building a Dockerfile that requires `--build-arg` for build time variables isn't

In the following example `Dockerfile`, several packages are installed:

```
```Dockerfile
cat << EOF > ./Dockerfile
FROM alpine

Expand All @@ -106,14 +106,14 @@ EOF

Build and run the container based on the Dockerfile in the previous example by running the following command:

```
```bash
container=$(wave --containerfile ./Dockerfile)
docker run --rm $container cowsay "Hello world"
```

In the following example `Dockerfile`, a local context is used:

```
```Dockerfile
cat << EOF > ./Dockerfile
FROM alpine
ADD hello.sh /usr/local/bin/
Expand All @@ -122,15 +122,15 @@ EOF

Create the shell script referenced in the previous example by running the following commands in your terminal:

```
```bash
mkdir -p build-context/
printf 'echo Hello world!' > build-context/hello.sh
chmod +x build-context/hello.sh
```

Build and run the container based on the Dockerfile in the previous example by running the following command:

```
```bash
docker run $(wave -f Dockerfile --context build-context) sh -c hello.sh
```
</details>
Expand Down Expand Up @@ -164,19 +164,19 @@ The following arguments are used to build a Singularity container:

In the following example, a Docker base image is augmented:

```
```bash
wave -i alpine --layer context-dir/ --build-repo docker.io/user/repo
```

In the following example, a SingularityCE def file is specified:

```
```bash
wave -f hello-world.def --singularity --freeze --build-repo docker.io/user/repo
```

In the following example, two Conda packages are specified:

```
```bash
wave --conda-package bamtools=2.5.2 --conda-package samtools=1.17 --freeze --singularity --build-repo docker.io/user/repo
```

Expand Down Expand Up @@ -208,7 +208,7 @@ The following arguments are used to freeze a container build:

In the following example, the `alpine` container image is frozen to a private DockerHub image registry. The `--tower-token` argument is not required if the `TOWER_ACCESS_TOKEN` environment variable is defined.

```
```bash
wave -i alpine --freeze \
--build-repo docker.io/user/repo --tower-token <TOKEN>
```
Expand Down
Loading