Skip to content

Commit 539c4e6

Browse files
Merge pull request #181 from ZeroIntensity/view-command-alias
View command alias
2 parents 08858d9 + 2b3d6dc commit 539c4e6

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

docs/getting-started/installation.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,10 @@ To ensure you've installed view.py correctly, run the `view` command:
3838
$ view
3939
```
4040

41+
!!! note Problem on Linux
42+
43+
On Linux, `view` is already a command! Read about it [here](https://www.ibm.com/docs/zh/aix/7.2?topic=v-view-command), but in short, it opens `vi` in read only mode. You can either shadow this command with view.py's CLI, or use the `view-admin` command instead, which is an alias. This documentation will assume you use `view` instead of `view-admin`, but note that they do the exact same thing.
44+
4145
If this doesn't work properly, try executing via Python:
4246

4347
```

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,7 @@ progress-style = ["bar"]
131131

132132
[project.scripts]
133133
view = "view.__main__:main"
134+
view-admin = "view.__main__:main"
134135

135136
[tool.mypy]
136137
exclude = ["src/view/databases.py", "src/view/components.py", "src/view/_codec.py"]

0 commit comments

Comments
 (0)