Skip to content
This repository has been archived by the owner on Apr 3, 2023. It is now read-only.

Commit

Permalink
update usage docs
Browse files Browse the repository at this point in the history
  • Loading branch information
blacktop committed Oct 9, 2016
1 parent 151ff70 commit f91c0c5
Showing 1 changed file with 31 additions and 6 deletions.
37 changes: 31 additions & 6 deletions docs/usage/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,25 @@
# Using Malice
Using Malice
============

TODO(blacktop)
Table of Contents
-----------------

This directory will hold documentation around using malice and how it works.
- [Download All Malice Plugins](#download-all-malice-plugins)
- [Run Malice](#run-malice)
- [Lookup a Hash](#lookup-a-hash)
- [Scan Some Malware](#scan-some-malware)

## Download All Malice Plugins
Download All Malice Plugins
---------------------------

```bash
$ malice plugin update --all
```

> **NOTE:** pulling down all of the plugins can take a long time depending on your network speed.
## Run Malice
Run Malice
----------

```bash
$ export MALICE_VT_API=<YOUR API KEY>
Expand Down Expand Up @@ -45,4 +52,22 @@ Commands:
help Shows a list of commands or help for one command

Run 'malice COMMAND --help' for more information on a command.
```
```

Lookup a Hash
-------------

```bash
$ malice lookup 6fe80e56ad4de610304bab1675ce84d16ab6988e
```

See [Lookup Output](https://github.com/maliceio/malice/blob/master/docs/examples/lookup.md)

Scan Some Malware
-----------------

```bash
$ malice scan befb88b89c2eb401900a68e9f5b78764203f2b48264fcc3f7121bf04a57fd408
```

See [Scan Output](https://github.com/maliceio/malice/blob/master/docs/examples/scan.md)

0 comments on commit f91c0c5

Please sign in to comment.