lima-vm / lima-vm/lima

`default` is a misnomer and `limactl shell --help` is confusing

Open
#1,500 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Go
Stars
21.9k
Forks
957
Avg merge
2d 6h
Merged PRs (30d)
53

Description

### Description

```sh
jsoref@jsoref-mbp ~ % limactl --version
limactl version 0.15.0
jsoref@jsoref-mbp ~ % limactl list
NAME STATUS SSH CPUS MEMORY DISK DIR
0 Stopped 127.0.0.1:0 4 4GiB 100GiB ~/.lima/0
alpine Stopped 127.0.0.1:0 4 4GiB 100GiB ~/.lima/alpine
default Running 127.0.0.1:60022 4 8GiB 100GiB ~/.lima/default
jsoref@jsoref-mbp ~ % limactl shell
FATA[0000] requires at least 1 arg(s), only received 0
jsoref@jsoref-mbp ~ % limactl shell --help
Execute shell in Lima

lima command is provided as an alias for limactl shell $LIMA_INSTANCE. $LIMA_INSTANCE defaults to "default".

By default, the first 'ssh' executable found in the host's PATH is used to connect to the Lima instance.
A custom ssh alias can be used instead by setting the $SSH environment variable.

Hint: try --debug to show the detailed logs, if it seems hanging (mostly due to some SSH issue).

Usage:
limactl shell INSTANCE [COMMAND...] [flags]

Flags:
-h, --help help for shell
--shell string shell interpreter, e.g. /bin/bash
--workdir string working directory

Global Flags:
--debug debug mode
jsoref@jsoref-mbp ~ % limactl shell default
jsoref@lima-default:/Users/jsoref$
logout
jsoref@jsoref-mbp ~ % limactl command
FATA[0000] unknown command "command" for "limactl"
```

Thoughts:
1. `default` should mean that anything that takes a thing of that type will use the `default` kind if none is specified. This isn't what happens
2. The help should say:

```
`lima` is provided as an alias for `limactl shell $LIMA_INSTANCE`. $LIMA_INSTANCE defaults to "default".
```

There's no reason for someone would intuit that `lima` is the _command_ and not `lima command` or something else.

3. This line should be reworded (`seems hanging` => `seems to hang` ??)

```
Hint: try --debug to show the detailed logs, if it seems hanging (mostly due to some SSH issue).
```

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.