Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #137

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #137

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ in the REST API that you would like to use, let us know at [email protected]
Authenticating to use the SDK / CLI can be done in a few ways.

#### Logging In
The simplest is to login to an organization using an [API key](https://doc.limacharlie.io/docs/documentation/docs/api_keys.md).
The simplest is to login to an organization using an [API key](https://docs.limacharlie.io/docs/platform-management-api-keys).

Use `limacharlie login` to store credentials locally. You will need an `OID` (Organization ID) and an API key, both
of which you can get from the "REST API" section of the web interface.
Expand Down Expand Up @@ -130,16 +130,16 @@ the `request` function to receive replies through a `FutureResults` object or th
`simpleRequest` to wait for the response and receive it as a return value.

#### Artifacts
The `Artifacts` is a helpful class to upload [Artifact Collection](https://doc.limacharlie.io/docs/documentation/docs/external_logs.md)
The `Artifacts` is a helpful class to upload [Artifact Collection](https://docs.limacharlie.io/docs/telemetry-artifacts)
to LimaCharlie without going through a sensor.

#### Payloads
The `Payloads` can be used to manage various executable [payloads](https://doc.limacharlie.io/docs/documentation/docs/payloads.md)
The `Payloads` can be used to manage various executable [payloads](https://docs.limacharlie.io/docs/telemetry-sensors-payloads)
accessible to sensors.

#### Replay
The `Replay` object allows you to interact with [Replay](https://doc.limacharlie.io/docs/documentation/docs/replay.md)
jobs managed by LimaCharlie. These allow you to re-run [D&R Rules](https://doc.limacharlie.io/docs/documentation/docs/dr.md)
The `Replay` object allows you to interact with [Replay](https://docs.limacharlie.io/docs/replay)
jobs managed by LimaCharlie. These allow you to re-run [D&R Rules](https://docs.limacharlie.io/docs/platform-management-config-hive-dr-rules)
on historical data.

#### Search
Expand Down Expand Up @@ -228,17 +228,17 @@ Shortcut utility to perform IOC searches across all locally configured organizat

#### Artifact Upload
`limacharlie artifacts upload --help`
Shortcut utility to upload [Artifact Collection](https://doc.limacharlie.io/docs/documentation/docs/external_logs.md) directly to
Shortcut utility to upload [Artifact Collection](https://docs.limacharlie.io/docs/telemetry-artifacts) directly to
LimaCharlie with just the CLI (no Agent).

#### Artifact Download
`limacharlie artifacts get_original --help`
Shortcut utility to download [Artifact Collection](https://doc.limacharlie.io/docs/documentation/docs/external_logs.md) in
Shortcut utility to download [Artifact Collection](https://docs.limacharlie.io/docs/telemetry-artifacts) in
LimaCharlie locally.

#### Replay
`limacharlie replay --help`
Shortcut utility to perform [Replay](https://doc.limacharlie.io/docs/documentation/docs/replay.md) jobs from the CLI.
Shortcut utility to perform [Replay](https://docs.limacharlie.io/docs/replay) jobs from the CLI.

#### Detection & Response
`limacharlie dr --help`
Expand Down