Skip to content

Commit f0239ed

Browse files
authored
Merge pull request #1138 from ia0/readme
Update README
2 parents f44dde1 + a3e7994 commit f0239ed

File tree

2 files changed

+26
-3
lines changed

2 files changed

+26
-3
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,8 @@ Magika is available as `magika` on PyPI:
7171
$ pip install magika
7272
```
7373

74-
If you intend to use Magika only as a command line, you may want to use `$ pipx install magika` instead.
74+
If you intend to use Magika only as a command line, you may want to use one of the alternatives
75+
listed in the [CLI readme](https://github.com/google/magika/tree/main/rust/cli#installation).
7576

7677
If you want to test out the latest release candidate, you can install with `pip install --pre magika`.
7778

rust/cli/README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,31 @@ on [GitHub](https://github.com/google/magika/issues).
1717

1818
## Installation
1919

20-
A recent version of the `magika` Rust client is included in the `magika` python package, which you can install with `pip install magika`.
20+
You can install the latest version from the `magika` python package:
2121

22-
To install the latest version from crates.io:
22+
```shell
23+
pipx install magika
24+
```
25+
26+
You can install the latest version from a shell using `curl`:
27+
28+
```shell
29+
curl -LsSf https://securityresearch.google/magika/install.sh | sh
30+
```
31+
32+
You can install the latest version from a shell using `wget`:
33+
34+
```shell
35+
wget -qO- https://securityresearch.google/magika/install.sh | sh
36+
```
37+
38+
You can install the latest version from a powershell:
39+
40+
```shell
41+
powershell -ExecutionPolicy Bypass -c "irm https://securityresearch.google/magika/install.ps1 | iex"
42+
```
43+
44+
You can install the latest version from crates.io:
2345

2446
```shell
2547
cargo install --locked magika-cli

0 commit comments

Comments
 (0)