Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions ModularGuard.slnx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
<File Path="AGENTS.md" />
<File Path="CHANGELOG.md" />
<File Path="compose.yml" />
<File Path="install.ps1" />
<File Path="install.sh" />
<File Path="LICENSE" />
<File Path="Makefile" />
<File Path="README.md" />
Expand Down
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,19 @@ Install ModularGuard with a single command:
#### Linux/macOS

```bash
curl -fsSL https://raw.githubusercontent.com/n2jsoft/modularguard/main/install.sh | bash
curl -fsSL https://raw.githubusercontent.com/n2jsoft-public-org/ModularGuard/main/install.sh | bash
```

Or with wget:

```bash
wget -qO- https://raw.githubusercontent.com/n2jsoft/modularguard/main/install.sh | bash
wget -qO- https://raw.githubusercontent.com/n2jsoft-public-org/ModularGuard/main/install.sh | bash
```

#### Windows (PowerShell)

```powershell
irm https://raw.githubusercontent.com/n2jsoft/modularguard/main/install.ps1 | iex
irm https://raw.githubusercontent.com/n2jsoft-public-org/ModularGuard/main/install.ps1 | iex
```

The installation script will:
Expand All @@ -49,12 +49,12 @@ The installation script will:
Pull the latest Docker image from GitHub Container Registry:

```bash
docker pull ghcr.io/n2jsoft/modularguard:latest
docker pull ghcr.io/n2jsoft-public-org/modularguard:latest
```

#### Option 2: Manual Binary Download

Download the latest release for your platform from the [releases page](https://github.com/n2jsoft/modularguard/releases):
Download the latest release for your platform from the [releases page](https://github.com/n2jsoft-public-org/ModularGuard/releases):

- **Linux (x64)**: `modularguard-linux-x64.tar.gz`
- **Linux (ARM64)**: `modularguard-linux-arm64.tar.gz`
Expand Down Expand Up @@ -82,8 +82,8 @@ Expand-Archive modularguard-win-x64.zip

```bash
# Clone the repository
git clone https://github.com/n2jsoft/modularguard.git
cd modularguard
git clone https://github.com/n2jsoft-public-org/ModularGuard.git
cd ModularGuard

# Build the project
dotnet build
Expand All @@ -98,13 +98,13 @@ dotnet run --project src/CLI -- check <path-to-your-project>

```bash
# Validate current directory
docker run --rm -v $(pwd):/workspace ghcr.io/n2jsoft/modularguard:latest check /workspace
docker run --rm -v $(pwd):/workspace ghcr.io/n2jsoft-public-org/modularguard:latest check /workspace

# Validate specific directory
docker run --rm -v /path/to/your/project:/workspace ghcr.io/n2jsoft/modularguard:latest check /workspace
docker run --rm -v /path/to/your/project:/workspace ghcr.io/n2jsoft-public-org/modularguard:latest check /workspace

# With output file
docker run --rm -v $(pwd):/workspace ghcr.io/n2jsoft/modularguard:latest check /workspace --format json --output /workspace/report.json
docker run --rm -v $(pwd):/workspace ghcr.io/n2jsoft-public-org/modularguard:latest check /workspace --format json --output /workspace/report.json
```

### Using Pre-built Binary
Expand All @@ -131,8 +131,8 @@ dotnet run --project src/CLI -- check /path/to/your/project

```bash
# Docker
docker run --rm -v $(pwd):/workspace ghcr.io/n2jsoft/modularguard:latest check /workspace --format json --output /workspace/report.json
docker run --rm -v $(pwd):/workspace ghcr.io/n2jsoft/modularguard:latest check /workspace --format markdown --output /workspace/report.md
docker run --rm -v $(pwd):/workspace ghcr.io/n2jsoft-public-org/modularguard:latest check /workspace --format json --output /workspace/report.json
docker run --rm -v $(pwd):/workspace ghcr.io/n2jsoft-public-org/modularguard:latest check /workspace --format markdown --output /workspace/report.md

# Binary
modularguard check . --format json --output report.json
Expand All @@ -148,7 +148,7 @@ dotnet run --project src/CLI -- check . --format markdown --output report.md

```bash
# Docker - Quiet mode (minimal output, good for CI/CD)
docker run --rm -v $(pwd):/workspace ghcr.io/n2jsoft/modularguard:latest check /workspace --quiet
docker run --rm -v $(pwd):/workspace ghcr.io/n2jsoft-public-org/modularguard:latest check /workspace --quiet

# Binary - Verbose mode (includes file paths)
modularguard check . --verbose
Expand Down
2 changes: 1 addition & 1 deletion install.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ param()
$ErrorActionPreference = 'Stop'

# Configuration
$Repo = "n2jsoft/modularguard"
$Repo = "n2jsoft-public-org/ModularGuard"
$InstallDir = Join-Path $env:USERPROFILE ".local\bin"
$BinaryName = "modularguard.exe"

Expand Down
2 changes: 1 addition & 1 deletion install.sh
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ YELLOW='\033[1;33m'
NC='\033[0m' # No Color

# Configuration
REPO="n2jsoft/modularguard"
REPO="n2jsoft-public-org/ModularGuard"
INSTALL_DIR="$HOME/.local/bin"
BINARY_NAME="modularguard"

Expand Down