Skip to content

Update Eldritch documentation to include all modules in module list #495

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

Merged
hulto merged 5 commits into from
Jan 23, 2024
Merged

Update Eldritch documentation to include all modules in module list #495

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a2ba12b
Update dev-guide eldritch.md
Alextibtab Jan 23, 2024
a3ac7ed
Update user-guide eldritch.md
Alextibtab Jan 23, 2024
9b938cb
Merge branch 'main' into patch-1
hulto Jan 23, 2024
07355c1
Merge branch 'main' into patch-1
hulto Jan 23, 2024
7c85e99
Merge branch 'main' into patch-1
hulto Jan 23, 2024
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
5 changes: 4 additions & 1 deletion docs/_docs/dev-guide/eldritch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
8 changes: 5 additions & 3 deletions docs/_docs/user-guide/eldritch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**

Expand Down