From a2ba12b04aebd6b2557d3584b719ec0cee36be3f Mon Sep 17 00:00:00 2001 From: Alex C <48660540+Alextibtab@users.noreply.github.com> Date: Tue, 23 Jan 2024 20:47:24 +0000 Subject: [PATCH 1/2] Update dev-guide eldritch.md Updated module section to include all modules --- docs/_docs/dev-guide/eldritch.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/_docs/dev-guide/eldritch.md b/docs/_docs/dev-guide/eldritch.md index 60f37992d..7640b31a5 100644 --- a/docs/_docs/dev-guide/eldritch.md +++ b/docs/_docs/dev-guide/eldritch.md @@ -32,11 +32,14 @@ Want to contribute to Eldritch but aren't sure what to build check our ["good fi `docs/_docs/user-guide/eldritch.md` Add your function to the docs. Give your function a unique and descriptive name. Assign it to an Eldritch module. -Currently Eldritch has four modules your function can fall under: +Currently Eldritch has seven modules your function can fall under: +* `assets`: Is used to interact with files stored natively in the agent. +* `crypto` Is used to encrypt/decrypt or hash data. * `file`: Is used for any on disk file processing. * `pivot`: Is used to migrate to identify, and migrate between systems. The pivot module is also responsible for facilitating connectivity within an environment. * `process`: Is used to manage running processes on a system. * `sys`: Is used to check system specific configurations and start new processes. +* `time`: Is used for obtaining and formatting time or adding delays into code If your function does not fall under a specific module reach out to the core developers about adding a new module or finding the right fit. From a3ac7ed163abe04e5e0a6af194e99664ecbb167d Mon Sep 17 00:00:00 2001 From: Alex C <48660540+Alextibtab@users.noreply.github.com> Date: Tue, 23 Jan 2024 20:54:18 +0000 Subject: [PATCH 2/2] Update user-guide eldritch.md --- docs/_docs/user-guide/eldritch.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/_docs/user-guide/eldritch.md b/docs/_docs/user-guide/eldritch.md index cf7471203..3f2d0d75c 100644 --- a/docs/_docs/user-guide/eldritch.md +++ b/docs/_docs/user-guide/eldritch.md @@ -81,16 +81,18 @@ write_systemd_service() The standard library is the default functionality that eldritch provides. -It currently contains five modules: +It currently contains seven modules: - `assets` - Used to interact with files stored natively in the agent. +- `crypto` - Used to encrypt/decrypt or hash data. - `file` - Used to interact with files on the system. - `pivot` - Used to identify and move between systems. - `process` - Used to interact with processes on the system. - `sys` - General system capabilities can include loading libraries, or information about the current context. -- `crypto` - Used to encrypt/decrypt or hash data. +- `time` - General functions for obtaining and formatting time, also add delays into code. + -Functions fall into one of these five modules. This is done to improve clarity about function use. +Functions fall into one of these seven modules. This is done to improve clarity about function use. **🚨 DANGER 🚨: Name shadowing**