Skip to content

doc: correct errors and inconsistencies in README.md #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nats merged 1 commit into from
Jan 21, 2026
Merged

doc: correct errors and inconsistencies in README.md #77

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,15 +79,15 @@ $ bl

usage: bl [OPTIONS] COMMAND

bl is a command-line interface for the binaryLane API
bl is a command-line interface for the BinaryLane API

Options:
--help Display available commands and descriptions

Available Commands:
account Access account commands
action Access action commands
configure Configure access to binaryLane API
configure Configure access to BinaryLane API
domain Access domain commands
image Access image commands
load-balancer Access load-balancer commands
Expand Down Expand Up @@ -160,7 +160,7 @@ Server creation is provided by the `bl server create` command. Use `--help` to
view all arguments and parameters:

```
$ bl server list --help
$ bl server create --help
usage: bl server create [OPTIONS] --size SIZE --image IMAGE --region REGION [PARAMETERS]

Create a new server.
Expand Down Expand Up @@ -198,7 +198,7 @@ Parameters:
```

In the help displayed by `bl`, **Arguments** are required and **Parameters**
are optional. For the `bl server list` command `--size SIZE`, `--image IMAGE`,
are optional. For the `bl server create` command `--size SIZE`, `--image IMAGE`,
and `--region REGION` are required. A list of available choices for each can be
displayed by running:

Expand All @@ -212,7 +212,7 @@ For example, to create a minimum-sized Ubuntu 22.04 LTS server in Sydney using
SSH public key authentication:

```
$ bl server create --size std-min --image ubuntu-22.04-lts --region syd
$ bl server create --size std-min --image ubuntu-22.04 --region syd
completed.
┌───────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────┐
│ name │ value │
Expand All @@ -225,7 +225,7 @@ completed.
│ created_at │ 2023-01-20T02:02:32+00:00 │
│ status │ new │
│ region │ Sydney │
│ image │ 20.04 LTS │
│ image │ 22.04 LTS │
│ size │ std-min │
│ size_slug │ std-min │
│ networks │ v4: [{'ip_address': '175.45.180.1', 'type': 'public', 'netmask': '255.255.255.0... │
Expand All @@ -245,7 +245,7 @@ For example, to create a server per the previous example with password
authentication:

```
$ bl server create --size std-min --image ubuntu-22.04-lts --region syd --password 'qq7s6GYZgbiVG3'
$ bl server create --size std-min --image ubuntu-22.04 --region syd --password 'qq7s6GYZgbiVG3'
```

Upon completion, the root password for the server in this example would be `qq7s6GYZgbiVG3`.
Expand Down Expand Up @@ -350,7 +350,7 @@ soon as the BinaryLane API accepts the requested command. To do so, include the
`--async` option in the command invocation. For example:

```
$ bl server create --size std-min --image ubuntu-22.04-lts --region syd --async
$ bl server create --size std-min --image ubuntu-22.04 --region syd --async
```

### Configuration file
Expand Down
Loading