devcontainers / devcontainers/cli

Build command mentions positional path argument

Open
#8 2 comments 2 reactions 1 assignee Claimed by @chrmarti View on GitHub
bug
Dominant language
TypeScript
Stars
3k
Forks
457
Avg merge
13h 17m
Merged PRs (30d)
6

Description

Should there not be `[path]` in the help page? Looks like `--workspace-folder` is required, not a positional argument known as `path`

```
@joshspicer ➜ /workspaces/features (test ✗) $ npx dev-containers-cli-0.1.0.tgz build /tmp/vsch/container-features-test/165219861073
dev-containers-cli build [path]

Build a dev container image

Options:
--help Show help [boolean]
--version Show version number [boolean]
--user-data-folder Host path to a directory that is intended to be persisted and share state between sessions.
[string]
--docker-path Docker CLI path. [string]
--docker-compose-path Docker Compose CLI path. [string]
--workspace-folder Workspace folder path. The devcontainer.json will be looked up relative to this path.
[string] [required]
--log-level Log level. [choices: "info", "debug", "trace"] [default: "info"]
--log-format Log format. [choices: "text", "json"] [default: "text"]
--no-cache Builds the image with `--no-cache`. [boolean] [default: false]
--image-name Image name. [string]
--cache-from Additional image to use as potential layer cache [string]

Missing required argument: workspace-folder
```

_Originally posted by @joshspicer in https://github.com/devcontainers/cli/pull/4#discussion_r869472726_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.