Skip to content

Commit 74c6596

Browse files
authored
Regenerate documentation (#67)
1 parent 6e23d13 commit 74c6596

File tree

418 files changed

+5969
-1312
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

418 files changed

+5969
-1312
lines changed

doc/vt.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,28 @@ A command-line tool for interacting with VirusTotal.
99
### Options
1010

1111
```
12-
-k, --apikey string api key
12+
-k, --apikey string API key
1313
-h, --help help for vt
14+
--proxy string HTTP proxy
1415
-v, --verbose verbose output
1516
```
1617

1718
### SEE ALSO
1819

1920
* [vt analysis](vt_analysis.md) - Get a file or URL analysis
21+
* [vt collection](vt_collection.md) - Get information about collections
2022
* [vt completion](vt_completion.md) - Output shell completion code for the specified shell (bash or zsh)
2123
* [vt domain](vt_domain.md) - Get information about Internet domains
2224
* [vt download](vt_download.md) - Download files
2325
* [vt file](vt_file.md) - Get information about files
2426
* [vt group](vt_group.md) - Get information about VirusTotal groups
2527
* [vt hunting](vt_hunting.md) - Manage malware hunting rules and notifications
2628
* [vt init](vt_init.md) - Initialize or re-initialize vt command-line tool
29+
* [vt iocstream](vt_iocstream.md) - Manage IoC Stream notifications
2730
* [vt ip](vt_ip.md) - Get information about IP addresses
2831
* [vt meta](vt_meta.md) - Returns metadata about VirusTotal
2932
* [vt monitor](vt_monitor.md) - Manage your monitor account
33+
* [vt monitorpartner](vt_monitorpartner.md) - Manage your monitor partner account
3034
* [vt retrohunt](vt_retrohunt.md) - Manage retrohunt jobs
3135
* [vt scan](vt_scan.md) - Scan files or URLs
3236
* [vt search](vt_search.md) - Search for files in VirusTotal Intelligence

doc/vt_analysis.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@ vt analysis [hash]... [flags]
3939
### Options inherited from parent commands
4040

4141
```
42-
-k, --apikey string api key
42+
-k, --apikey string API key
43+
--proxy string HTTP proxy
4344
-v, --verbose verbose output
4445
```
4546

doc/vt_collection.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
## vt collection
2+
3+
Get information about collections
4+
5+
### Synopsis
6+
7+
Get information about one or more collections.
8+
9+
This command receives one or more collection IDs and returns information about
10+
them. The information for each collection is returned in the same order as the
11+
collections are passed to the command.
12+
13+
If the command receives a single hypen (-) the collection will be read from
14+
the standard input, one per line.
15+
16+
```
17+
vt collection [collection]... [flags]
18+
```
19+
20+
### Examples
21+
22+
```
23+
vt collection malpedia_win_emotet
24+
vt collection malpedia_win_emotet alienvault_603eb1abdd4812819c64e197
25+
cat list_of_collections | vt collection -n [collection_name] -d [collection_description] -
26+
```
27+
28+
### Options
29+
30+
```
31+
-x, --exclude strings exclude fields matching the provided pattern
32+
-h, --help help for collection
33+
-I, --identifiers-only print identifiers only
34+
-i, --include strings include fields matching the provided pattern (default [**])
35+
-t, --threads int number of threads working in parallel (default 5)
36+
```
37+
38+
### Options inherited from parent commands
39+
40+
```
41+
-k, --apikey string API key
42+
--proxy string HTTP proxy
43+
-v, --verbose verbose output
44+
```
45+
46+
### SEE ALSO
47+
48+
* [vt](vt.md) - A command-line tool for interacting with VirusTotal
49+
* [vt collection attack_techniques](vt_collection_attack_techniques.md) - Collection's ATT&CK techniques.
50+
* [vt collection autogenerated_graphs](vt_collection_autogenerated_graphs.md) - Autogenerated graphs related to the collection.
51+
* [vt collection comments](vt_collection_comments.md) - Comments for the collection.
52+
* [vt collection create](vt_collection_create.md) - Create a collection.
53+
* [vt collection delete](vt_collection_delete.md) - Delete a collection.
54+
* [vt collection domains](vt_collection_domains.md) - Collection's domains.
55+
* [vt collection files](vt_collection_files.md) - Collection's files.
56+
* [vt collection ip_addresses](vt_collection_ip_addresses.md) - Collection's IP addresses.
57+
* [vt collection owner](vt_collection_owner.md) - User who created the collection.
58+
* [vt collection references](vt_collection_references.md) - Collection's references.
59+
* [vt collection relationships](vt_collection_relationships.md) - Get all relationships.
60+
* [vt collection remove](vt_collection_remove.md) - Remove items from a collection.
61+
* [vt collection rename](vt_collection_rename.md) - Rename collection.
62+
* [vt collection sigma_rules](vt_collection_sigma_rules.md) - Collection's SIGMA rules.
63+
* [vt collection stats](vt_collection_stats.md) - Monthly lookup and submission stats per country.
64+
* [vt collection subscribed_users](vt_collection_subscribed_users.md) - Users subscribed to the collection.
65+
* [vt collection subscription_preferences](vt_collection_subscription_preferences.md) - Subscription preference for the given user.
66+
* [vt collection threat_actors](vt_collection_threat_actors.md) - Collection's threat actors.
67+
* [vt collection update](vt_collection_update.md) - Add new items to a collection.
68+
* [vt collection urls](vt_collection_urls.md) - Collection's URLs.
69+
* [vt collection yara_rulesets](vt_collection_yara_rulesets.md) - Collection's YARA rulesets.
70+
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## vt collection attack_techniques
2+
3+
Collection's ATT&CK techniques.
4+
5+
```
6+
vt collection attack_techniques [collection] [flags]
7+
```
8+
9+
### Options
10+
11+
```
12+
-c, --cursor string cursor for continuing where the previous request left
13+
-x, --exclude strings exclude fields matching the provided pattern
14+
-h, --help help for attack_techniques
15+
-I, --identifiers-only print identifiers only
16+
-i, --include strings include fields matching the provided pattern (default [**])
17+
-n, --limit int maximum number of results (default 10)
18+
```
19+
20+
### Options inherited from parent commands
21+
22+
```
23+
-k, --apikey string API key
24+
--proxy string HTTP proxy
25+
-v, --verbose verbose output
26+
```
27+
28+
### SEE ALSO
29+
30+
* [vt collection](vt_collection.md) - Get information about collections
31+
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## vt collection autogenerated_graphs
2+
3+
Autogenerated graphs related to the collection.
4+
5+
```
6+
vt collection autogenerated_graphs [collection] [flags]
7+
```
8+
9+
### Options
10+
11+
```
12+
-c, --cursor string cursor for continuing where the previous request left
13+
-x, --exclude strings exclude fields matching the provided pattern
14+
-h, --help help for autogenerated_graphs
15+
-I, --identifiers-only print identifiers only
16+
-i, --include strings include fields matching the provided pattern (default [**])
17+
-n, --limit int maximum number of results (default 10)
18+
```
19+
20+
### Options inherited from parent commands
21+
22+
```
23+
-k, --apikey string API key
24+
--proxy string HTTP proxy
25+
-v, --verbose verbose output
26+
```
27+
28+
### SEE ALSO
29+
30+
* [vt collection](vt_collection.md) - Get information about collections
31+

doc/vt_collection_comments.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## vt collection comments
2+
3+
Comments for the collection.
4+
5+
```
6+
vt collection comments [collection] [flags]
7+
```
8+
9+
### Options
10+
11+
```
12+
-c, --cursor string cursor for continuing where the previous request left
13+
-x, --exclude strings exclude fields matching the provided pattern
14+
-h, --help help for comments
15+
-I, --identifiers-only print identifiers only
16+
-i, --include strings include fields matching the provided pattern (default [**])
17+
-n, --limit int maximum number of results (default 10)
18+
```
19+
20+
### Options inherited from parent commands
21+
22+
```
23+
-k, --apikey string API key
24+
--proxy string HTTP proxy
25+
-v, --verbose verbose output
26+
```
27+
28+
### SEE ALSO
29+
30+
* [vt collection](vt_collection.md) - Get information about collections
31+

doc/vt_collection_create.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
## vt collection create
2+
3+
Create a collection.
4+
5+
### Synopsis
6+
7+
Creates a collection from a list of IOCs.
8+
9+
This command receives one of more IoCs (sha256 hashes, URLs, domains, IP addresses)
10+
and creates a collection from them.
11+
12+
If the command receives a single hypen (-) the IoCs will be read from the
13+
standard input.
14+
15+
```
16+
vt collection create [ioc]... [flags]
17+
```
18+
19+
### Examples
20+
21+
```
22+
vt collection create -n [collection_name] -d [collection_description] www.example.com
23+
vt collection create -n [collection_name] -d [collection_description] www.example.com 8.8.8.8
24+
cat list_of_iocs | vt collection create -n [collection_name] -d [collection_description] -
25+
```
26+
27+
### Options
28+
29+
```
30+
-d, --description string Collection's description (required)
31+
-x, --exclude strings exclude fields matching the provided pattern
32+
-h, --help help for create
33+
-I, --identifiers-only print identifiers only
34+
-i, --include strings include fields matching the provided pattern (default [**])
35+
-n, --name string Collection's name (required)
36+
```
37+
38+
### Options inherited from parent commands
39+
40+
```
41+
-k, --apikey string API key
42+
--proxy string HTTP proxy
43+
-v, --verbose verbose output
44+
```
45+
46+
### SEE ALSO
47+
48+
* [vt collection](vt_collection.md) - Get information about collections
49+

doc/vt_collection_delete.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## vt collection delete
2+
3+
Delete a collection.
4+
5+
### Synopsis
6+
7+
Delete a collection.
8+
9+
This command receives a collection ID and deletes it.
10+
11+
```
12+
vt collection delete [collection id] [flags]
13+
```
14+
15+
### Examples
16+
17+
```
18+
vt collection delete [collection id]
19+
```
20+
21+
### Options
22+
23+
```
24+
-h, --help help for delete
25+
```
26+
27+
### Options inherited from parent commands
28+
29+
```
30+
-k, --apikey string API key
31+
--proxy string HTTP proxy
32+
-v, --verbose verbose output
33+
```
34+
35+
### SEE ALSO
36+
37+
* [vt collection](vt_collection.md) - Get information about collections
38+

doc/vt_collection_domains.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## vt collection domains
2+
3+
Collection's domains.
4+
5+
```
6+
vt collection domains [collection] [flags]
7+
```
8+
9+
### Options
10+
11+
```
12+
-c, --cursor string cursor for continuing where the previous request left
13+
-x, --exclude strings exclude fields matching the provided pattern
14+
-h, --help help for domains
15+
-I, --identifiers-only print identifiers only
16+
-i, --include strings include fields matching the provided pattern (default [**])
17+
-n, --limit int maximum number of results (default 10)
18+
```
19+
20+
### Options inherited from parent commands
21+
22+
```
23+
-k, --apikey string API key
24+
--proxy string HTTP proxy
25+
-v, --verbose verbose output
26+
```
27+
28+
### SEE ALSO
29+
30+
* [vt collection](vt_collection.md) - Get information about collections
31+

doc/vt_collection_files.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## vt collection files
2+
3+
Collection's files.
4+
5+
```
6+
vt collection files [collection] [flags]
7+
```
8+
9+
### Options
10+
11+
```
12+
-c, --cursor string cursor for continuing where the previous request left
13+
-x, --exclude strings exclude fields matching the provided pattern
14+
-h, --help help for files
15+
-I, --identifiers-only print identifiers only
16+
-i, --include strings include fields matching the provided pattern (default [**])
17+
-n, --limit int maximum number of results (default 10)
18+
```
19+
20+
### Options inherited from parent commands
21+
22+
```
23+
-k, --apikey string API key
24+
--proxy string HTTP proxy
25+
-v, --verbose verbose output
26+
```
27+
28+
### SEE ALSO
29+
30+
* [vt collection](vt_collection.md) - Get information about collections
31+

0 commit comments

Comments
 (0)