silverhack / silverhack/monkey365

Change default output directory to monkey365-output

Open
#185 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
PowerShell
Stars
1.3k
Forks
140
PR merge metrics
No merged PRs in 30d

Description

Is your feature request related to a problem? Please describe.
Monkey365 currently writes output by default under the module directory using the following format:

monkey365/monkey-reports/$GUID/$FORMAT/$FILE

The default output path should be changed so generated files are written outside the module directory. Additionally, the default folder name should also change from monkey-reports to monkey365-output.

The current behaviour is that when -OutDir is not specified, Monkey365 creates output inside the module. This behavior is documented here https://silverhack.github.io/monkey365/exporting/exporting-data/#data-location

Describe the solution you'd like

  • When -OutDir is specified, Monkey365 must keep using the provided path.
  • When -OutDir is not specified, Monkey365 must save data under the current working directory (./monkey365-output/$GUID/$FORMAT/$FILE)

The above must works on Windows PowerShell and PowerShell Core on Windows and Linux

Additional context
Monkey365 PowerShell module directory should contain the module files. Writing output there can cause problems when the module is installed in a protected or shared location, such as Program Files, a system-wide module path, a Docker image, or a CI/CD runner.

This change also helps reorganize the repository and module structure by keeping generated files outside the module path.

Related issues:

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how the -OutDir parameter is handled and where the default output path is constructed; the issue's data-location documentation describes the current behavior. Verify that an explicit -OutDir remains unchanged, while the default uses the current working directory and monkey365-output/$GUID/$FORMAT/$FILE. Test the behavior on Windows PowerShell and PowerShell Core on Windows and Linux.

Written by the indexing model from the issue text.

Assessment

Tech stack
powershell
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.