You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-4Lines changed: 15 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,9 +15,9 @@ In short, Twyn protects you against [typosquatting attacks](https://en.wikipedia
15
15
16
16
It works as follows:
17
17
18
-
1.It will try to find a dependencies file in your working path. You can freely specify a different path for that file.
19
-
2. If your installed package name matches with the name of one of the most well known packages, the package is accepted.
20
-
3. If the name of your package is similar to the name one of the most used packages, Twyn will prompt an error.
18
+
1.Either choose to scan the dependencies in a dependencies file you specify (`--dependency-file`) or some dependencies introduced through the CLI (`--dependency`). If no option was provided, it will try to find a dependencies file in your working path.
19
+
2. If the name of your package name matches with the name of one of the most well known packages, the package is accepted.
20
+
3. If the name of your package is similar to the name of one of the most used packages, Twyn will prompt an error.
21
21
4. If your package name is not in the list of the most known ones and is not similar enough to any of those to be considered misspelled, the package is accepted. Twyn assumes that you're using either a not so popular package (therefore it can't verify its legitimacy) or a package created by yourself, therefore unknown for the rest.
22
22
23
23
## Docker
@@ -60,6 +60,17 @@ Currently it supports these dependency file formats.
60
60
-`requirements.txt`
61
61
-`poetry.lock`
62
62
63
+
### Check dependencies introduced through the CLI
64
+
You can also check a dependency by entering it through the command line:
65
+
66
+
twyn run --dependency <dependency>
67
+
68
+
It does accept multiple dependencies at a time:
69
+
70
+
twyn run --dependency <dependency> --dependency <another_dependency>
71
+
72
+
When this option is selected, no dependency file is checked.
73
+
63
74
### Selector method
64
75
You can choose between different operational modes:
65
76
-`all`: Default option. It is the most exhaustive mode. It will check your package names against the trusted ones without any assumption.
@@ -84,4 +95,4 @@ All the configurations available through the command line are also supported in
0 commit comments