Skip to content

Commit

Permalink
docs: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
MSAdministrator committed Mar 6, 2023
1 parent 5a1115d commit c6e89d0
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Additionally, `atomic-operator` can be used in many other situations like:
* A command-line and importable Python package
* Select specific tests when one or more techniques are specified
* Search across all atomics for that perfect test
* Pass input_arguments as input for tests via command line
* Plus more

## Getting Started
Expand Down Expand Up @@ -148,6 +149,12 @@ Will prompt the user with a selection list of tests associated with that techniq
Show all hidden files (9a1ec7da-b892-449f-ad68-67066d04380c)
```

The following will allow you to provide custom input arguments for tests. You do this providing a dictionary of keys and values as a dictionary to the `input_arguments` parameter on the run method.

```bash
atomic-operator run --techniques T1564.001 --input_arguments {"project-id": "some_value", "another_key": "another value"}
```

### Running Tests Remotely

In order to run a test remotely you must provide some additional properties (and options if desired). The main method to run tests is named `run`.
Expand Down Expand Up @@ -175,6 +182,7 @@ atomic-operator run -- --help
|test_guids|list|None|One or more Atomic test GUIDs.|
|select_tests|bool|False|Select one or more atomic tests to run when a techniques are specified.|
|atomics_path|str|os.getcwd()|The path of Atomic tests.|
|input_arguments|dict|{}|A dictionary of input arguments to pass to the test.|
|check_prereqs|bool|False|Whether or not to check for prereq dependencies (prereq_comand).|
|get_prereqs|bool|False|Whether or not you want to retrieve prerequisites.|
|cleanup|bool|False|Whether or not you want to run cleanup command(s).|
Expand All @@ -196,8 +204,6 @@ atomic-operator run -- --help
|**kwargs|dict|None|If additional flags are passed into the run command then we will attempt to match them with defined inputs within Atomic tests and replace their value with the provided value.|




You should see a similar output to the following:

```text
Expand Down Expand Up @@ -226,6 +232,9 @@ FLAGS
--atomics_path=ATOMICS_PATH
Default: '/U...
The path of Atomic tests. Defaults to os.getcwd().
--input_arguments={}
Default: {}
  A dictionary of input arguments to pass to the test.
--check_prereqs=CHECK_PREREQS
Default: False
Whether or not to check for prereq dependencies (prereq_comand). Defaults to False.
Expand Down

0 comments on commit c6e89d0

Please sign in to comment.