Skip to content

Enhances output options and adds project documentation - #18

Closed
JVBotelho wants to merge 3 commits into
mainfrom
docs/contributing-guide
Closed

Enhances output options and adds project documentation#18
JVBotelho wants to merge 3 commits into
mainfrom
docs/contributing-guide

Conversation

@JVBotelho

Copy link
Copy Markdown
Owner

Improves the flexibility and security of output file handling, and adds comprehensive project documentation and metadata.

  • Output Handling:

    • The --output argument now accepts existing directories, writing to ghosthound_output.json within them.
    • Performs upfront validation of output paths and parent directories, providing clearer error messages.
    • Standardizes output file permissions to 0600 on Unix systems to restrict access to generated JSON.
    • Moves output path resolution and file writing logic to a dedicated output module for improved modularity.
    • Adds a --no-banner flag to suppress the startup banner, which is useful for scripting.
  • Project Documentation & Metadata:

    • Adds a CONTRIBUTING.md guide with detailed instructions on toolchain, local checks, dependencies, and vulnerability reporting.
    • Includes a CITATION.cff file for formal citation metadata, enhancing discoverability and proper attribution.
    • Updates README.md to reflect new output behavior, the required Rust version (1.85+), and links to new documentation.
    • Adds authors and homepage metadata to all crate Cargo.toml files.

Move output path resolution and display after the NTLM check. This prevents unnecessary work and output if NTLM authentication is disabled, as the program would exit early.
@JVBotelho JVBotelho added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 9, 2026
@JVBotelho JVBotelho closed this Aug 9, 2026
@JVBotelho
JVBotelho deleted the docs/contributing-guide branch August 9, 2026 16:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant