Skip to content

Commit

Permalink
Regenerate documentation (#67)
Browse files Browse the repository at this point in the history
  • Loading branch information
joseotoro committed Feb 24, 2023
1 parent 6e23d13 commit 74c6596
Show file tree
Hide file tree
Showing 418 changed files with 5,969 additions and 1,312 deletions.
6 changes: 5 additions & 1 deletion doc/vt.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,28 @@ A command-line tool for interacting with VirusTotal.
### Options

```
-k, --apikey string api key
-k, --apikey string API key
-h, --help help for vt
--proxy string HTTP proxy
-v, --verbose verbose output
```

### SEE ALSO

* [vt analysis](vt_analysis.md) - Get a file or URL analysis
* [vt collection](vt_collection.md) - Get information about collections
* [vt completion](vt_completion.md) - Output shell completion code for the specified shell (bash or zsh)
* [vt domain](vt_domain.md) - Get information about Internet domains
* [vt download](vt_download.md) - Download files
* [vt file](vt_file.md) - Get information about files
* [vt group](vt_group.md) - Get information about VirusTotal groups
* [vt hunting](vt_hunting.md) - Manage malware hunting rules and notifications
* [vt init](vt_init.md) - Initialize or re-initialize vt command-line tool
* [vt iocstream](vt_iocstream.md) - Manage IoC Stream notifications
* [vt ip](vt_ip.md) - Get information about IP addresses
* [vt meta](vt_meta.md) - Returns metadata about VirusTotal
* [vt monitor](vt_monitor.md) - Manage your monitor account
* [vt monitorpartner](vt_monitorpartner.md) - Manage your monitor partner account
* [vt retrohunt](vt_retrohunt.md) - Manage retrohunt jobs
* [vt scan](vt_scan.md) - Scan files or URLs
* [vt search](vt_search.md) - Search for files in VirusTotal Intelligence
Expand Down
3 changes: 2 additions & 1 deletion doc/vt_analysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ vt analysis [hash]... [flags]
### Options inherited from parent commands

```
-k, --apikey string api key
-k, --apikey string API key
--proxy string HTTP proxy
-v, --verbose verbose output
```

Expand Down
70 changes: 70 additions & 0 deletions doc/vt_collection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
## vt collection

Get information about collections

### Synopsis

Get information about one or more collections.

This command receives one or more collection IDs and returns information about
them. The information for each collection is returned in the same order as the
collections are passed to the command.

If the command receives a single hypen (-) the collection will be read from
the standard input, one per line.

```
vt collection [collection]... [flags]
```

### Examples

```
vt collection malpedia_win_emotet
vt collection malpedia_win_emotet alienvault_603eb1abdd4812819c64e197
cat list_of_collections | vt collection -n [collection_name] -d [collection_description] -
```

### Options

```
-x, --exclude strings exclude fields matching the provided pattern
-h, --help help for collection
-I, --identifiers-only print identifiers only
-i, --include strings include fields matching the provided pattern (default [**])
-t, --threads int number of threads working in parallel (default 5)
```

### Options inherited from parent commands

```
-k, --apikey string API key
--proxy string HTTP proxy
-v, --verbose verbose output
```

### SEE ALSO

* [vt](vt.md) - A command-line tool for interacting with VirusTotal
* [vt collection attack_techniques](vt_collection_attack_techniques.md) - Collection's ATT&CK techniques.
* [vt collection autogenerated_graphs](vt_collection_autogenerated_graphs.md) - Autogenerated graphs related to the collection.
* [vt collection comments](vt_collection_comments.md) - Comments for the collection.
* [vt collection create](vt_collection_create.md) - Create a collection.
* [vt collection delete](vt_collection_delete.md) - Delete a collection.
* [vt collection domains](vt_collection_domains.md) - Collection's domains.
* [vt collection files](vt_collection_files.md) - Collection's files.
* [vt collection ip_addresses](vt_collection_ip_addresses.md) - Collection's IP addresses.
* [vt collection owner](vt_collection_owner.md) - User who created the collection.
* [vt collection references](vt_collection_references.md) - Collection's references.
* [vt collection relationships](vt_collection_relationships.md) - Get all relationships.
* [vt collection remove](vt_collection_remove.md) - Remove items from a collection.
* [vt collection rename](vt_collection_rename.md) - Rename collection.
* [vt collection sigma_rules](vt_collection_sigma_rules.md) - Collection's SIGMA rules.
* [vt collection stats](vt_collection_stats.md) - Monthly lookup and submission stats per country.
* [vt collection subscribed_users](vt_collection_subscribed_users.md) - Users subscribed to the collection.
* [vt collection subscription_preferences](vt_collection_subscription_preferences.md) - Subscription preference for the given user.
* [vt collection threat_actors](vt_collection_threat_actors.md) - Collection's threat actors.
* [vt collection update](vt_collection_update.md) - Add new items to a collection.
* [vt collection urls](vt_collection_urls.md) - Collection's URLs.
* [vt collection yara_rulesets](vt_collection_yara_rulesets.md) - Collection's YARA rulesets.

31 changes: 31 additions & 0 deletions doc/vt_collection_attack_techniques.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
## vt collection attack_techniques

Collection's ATT&CK techniques.

```
vt collection attack_techniques [collection] [flags]
```

### Options

```
-c, --cursor string cursor for continuing where the previous request left
-x, --exclude strings exclude fields matching the provided pattern
-h, --help help for attack_techniques
-I, --identifiers-only print identifiers only
-i, --include strings include fields matching the provided pattern (default [**])
-n, --limit int maximum number of results (default 10)
```

### Options inherited from parent commands

```
-k, --apikey string API key
--proxy string HTTP proxy
-v, --verbose verbose output
```

### SEE ALSO

* [vt collection](vt_collection.md) - Get information about collections

31 changes: 31 additions & 0 deletions doc/vt_collection_autogenerated_graphs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
## vt collection autogenerated_graphs

Autogenerated graphs related to the collection.

```
vt collection autogenerated_graphs [collection] [flags]
```

### Options

```
-c, --cursor string cursor for continuing where the previous request left
-x, --exclude strings exclude fields matching the provided pattern
-h, --help help for autogenerated_graphs
-I, --identifiers-only print identifiers only
-i, --include strings include fields matching the provided pattern (default [**])
-n, --limit int maximum number of results (default 10)
```

### Options inherited from parent commands

```
-k, --apikey string API key
--proxy string HTTP proxy
-v, --verbose verbose output
```

### SEE ALSO

* [vt collection](vt_collection.md) - Get information about collections

31 changes: 31 additions & 0 deletions doc/vt_collection_comments.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
## vt collection comments

Comments for the collection.

```
vt collection comments [collection] [flags]
```

### Options

```
-c, --cursor string cursor for continuing where the previous request left
-x, --exclude strings exclude fields matching the provided pattern
-h, --help help for comments
-I, --identifiers-only print identifiers only
-i, --include strings include fields matching the provided pattern (default [**])
-n, --limit int maximum number of results (default 10)
```

### Options inherited from parent commands

```
-k, --apikey string API key
--proxy string HTTP proxy
-v, --verbose verbose output
```

### SEE ALSO

* [vt collection](vt_collection.md) - Get information about collections

49 changes: 49 additions & 0 deletions doc/vt_collection_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
## vt collection create

Create a collection.

### Synopsis

Creates a collection from a list of IOCs.

This command receives one of more IoCs (sha256 hashes, URLs, domains, IP addresses)
and creates a collection from them.

If the command receives a single hypen (-) the IoCs will be read from the
standard input.

```
vt collection create [ioc]... [flags]
```

### Examples

```
vt collection create -n [collection_name] -d [collection_description] www.example.com
vt collection create -n [collection_name] -d [collection_description] www.example.com 8.8.8.8
cat list_of_iocs | vt collection create -n [collection_name] -d [collection_description] -
```

### Options

```
-d, --description string Collection's description (required)
-x, --exclude strings exclude fields matching the provided pattern
-h, --help help for create
-I, --identifiers-only print identifiers only
-i, --include strings include fields matching the provided pattern (default [**])
-n, --name string Collection's name (required)
```

### Options inherited from parent commands

```
-k, --apikey string API key
--proxy string HTTP proxy
-v, --verbose verbose output
```

### SEE ALSO

* [vt collection](vt_collection.md) - Get information about collections

38 changes: 38 additions & 0 deletions doc/vt_collection_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## vt collection delete

Delete a collection.

### Synopsis

Delete a collection.

This command receives a collection ID and deletes it.

```
vt collection delete [collection id] [flags]
```

### Examples

```
vt collection delete [collection id]
```

### Options

```
-h, --help help for delete
```

### Options inherited from parent commands

```
-k, --apikey string API key
--proxy string HTTP proxy
-v, --verbose verbose output
```

### SEE ALSO

* [vt collection](vt_collection.md) - Get information about collections

31 changes: 31 additions & 0 deletions doc/vt_collection_domains.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
## vt collection domains

Collection's domains.

```
vt collection domains [collection] [flags]
```

### Options

```
-c, --cursor string cursor for continuing where the previous request left
-x, --exclude strings exclude fields matching the provided pattern
-h, --help help for domains
-I, --identifiers-only print identifiers only
-i, --include strings include fields matching the provided pattern (default [**])
-n, --limit int maximum number of results (default 10)
```

### Options inherited from parent commands

```
-k, --apikey string API key
--proxy string HTTP proxy
-v, --verbose verbose output
```

### SEE ALSO

* [vt collection](vt_collection.md) - Get information about collections

31 changes: 31 additions & 0 deletions doc/vt_collection_files.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
## vt collection files

Collection's files.

```
vt collection files [collection] [flags]
```

### Options

```
-c, --cursor string cursor for continuing where the previous request left
-x, --exclude strings exclude fields matching the provided pattern
-h, --help help for files
-I, --identifiers-only print identifiers only
-i, --include strings include fields matching the provided pattern (default [**])
-n, --limit int maximum number of results (default 10)
```

### Options inherited from parent commands

```
-k, --apikey string API key
--proxy string HTTP proxy
-v, --verbose verbose output
```

### SEE ALSO

* [vt collection](vt_collection.md) - Get information about collections

31 changes: 31 additions & 0 deletions doc/vt_collection_ip_addresses.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
## vt collection ip_addresses

Collection's IP addresses.

```
vt collection ip_addresses [collection] [flags]
```

### Options

```
-c, --cursor string cursor for continuing where the previous request left
-x, --exclude strings exclude fields matching the provided pattern
-h, --help help for ip_addresses
-I, --identifiers-only print identifiers only
-i, --include strings include fields matching the provided pattern (default [**])
-n, --limit int maximum number of results (default 10)
```

### Options inherited from parent commands

```
-k, --apikey string API key
--proxy string HTTP proxy
-v, --verbose verbose output
```

### SEE ALSO

* [vt collection](vt_collection.md) - Get information about collections

Loading

0 comments on commit 74c6596

Please sign in to comment.