Command-line-docs

.github/workflows/gpt-auto-pr-description.yml

@@ -0,0 +1,17 @@
+name: Draft PR Description
+on:
+  pull_request:
+    types: [synchronize, opened, reopened, edited]
+
+jobs:
+  change-description:
+    runs-on: ubuntu-latest
+    name: Draft PR Description
+    steps:
+      - name: Add Draft PR description
+        uses: fluxinc/gpt-auto-pr-description-action@master
+        with:
+          trigger-word: "ai-draft"
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          pr-number: ${{ github.event.pull_request.number }}
+          openai-token: ${{ secrets.OPENAI_API_KEY }}

docs/.vitepress/config.mjs

@@ -29,7 +29,7 @@ export default defineConfig({
               { text: "Overview", link: "/dicom-capacitor/overview" },
               { text: "Installation", link: "/dicom-capacitor/installation" },
               { text: "Docker", link: "/dicom-capacitor/docker" },
-              { text: "Command Line", link: "/dicom-capacitor/command-line" },
+              { text: "Command Line Options", link: "/dicom-capacitor/command-line" },
               {
                 text: "Configuration",
                 link: "/dicom-capacitor/configuration",

docs/dicom-capacitor/command-line.md

@@ -1,12 +1,41 @@
 # Command Line Options
 
-Capacitor accepts the following command line options:
+## Basic Syntax
+```bash
+DICOMCapacitorService.exe [options]
+```
 
-- `--path`: Sets the path to the configuration files (default: `%ProgramData%\Flux\DICOM Capacitor\`)
+## Service Options
+- `--uninstall`, `-u`: Remove Windows service
+- `--restart-service [PID]`, `-rs [PID]`: Restart service using process ID
+- `--path`: Sets the path to the configuration files (default: `%ProgramData%\Flux Inc\DICOM Capacitor\`)
+
+## Configuration Options
+- `--activation-code [CODE]`, `-a [CODE]`: Set product activation code
 - `--no-storage-scu`: Disables the Storage SCU
 - `--no-worklist-scu`: Disables the Worklist SCU
 - `--no-prepare`: Disables preparation, which is the process of preparing files for storage
 - `--save-config`: Saves the current settings to the `config.yml` file.  Be careful with this option, as it
   will overwrite the existing `config.yml` file.
+
+## Development Options
 - `--mutate`: Applies the mutations defined in `mutations.yml`. This option requires a list of
   DICOM files to be provided, and is intended for testing purposes.
+- `--clear-secure-logs [PASSWORD]`: Clear secure audit logs
+- `--quit`, `-q`: Exit after running commands
+
+## Examples
+
+### Set Activation
+```bash
+DICOMCapacitorService.exe --activation-code "XXXX-XXXX-XXXX" --save-config
+```
+
+### Development Usage
+```bash
+# Process single file
+DICOMCapacitorService.exe --mutate [SRC_AE] [DST_AE] [IN_DCM_FILE] [OUT_DCM_FILE]
+
+# Clear logs
+DICOMCapacitorService.exe --clear-secure-logs "password"
+```

docs/dicom-capacitor/installation.md

@@ -8,18 +8,58 @@
 - 1 GB of free disk space
 - 2 GHz or faster, x64 or arm64, processor
 
-## Windows Installation
+## Installation
 
-1. Download the latest version of DICOM Capacitor from the [Flux Website](#)
+1. Download the latest version of DICOM Capacitor from the [Flux Website](https://store.fluxinc.ca/files)
 2. Run the installer
 3. Open your Services MMC and start and stop the DICOM Capacitor service
-4. Open the `%ProgramData%\Flux\DICOM Capacitor\` folder, which contains the following files
+4. Open the `%ProgramData%\Flux Inc\DICOM Capacitor\` folder, which contains the following files
     - `cache/` - Contains the cache of DICOM data
     - `log/` - Contains the logs for DICOM Capacitor
         - `capacitor_service.log` - Contains the main log for DICOM Capacitor
     - `nodes.yml` - Specifies the nodes that DICOM Capacitor will use to send and receive DICOM data
     - `config.yml` - Specifies the settings for DICOM Capacitor
 
+You can override the default location using the path option:
+```bash
+DICOMCapacitorService --path /custom/path
+```
+
+## Configuration
+The service configuration is stored in the `config.yml` file.
+
+## Service Management
+
+### Service Components
+During startup, the service initializes:
+- Storage SCP (DICOM storage provider)
+- Worklist SCP (DICOM worklist provider)
+- Query/Retrieve SCP
+- Storage Commitment SCP
+
+### Service Configuration
+Configure core service behavior from the command line:
+```bash
+# Disable Storage SCU
+DICOMCapacitorService.exe --no-storage-scu
+
+# Disable Worklist SCU
+DICOMCapacitorService.exe --no-worklist-scu
+
+# Disable file preparation
+DICOMCapacitorService.exe --no-prepare
+```
+
+## Logging
+- Service logs: `[LogPath]/capacitor_service.log`
+- Audit logs: `[LogPath]/capacitor_service_audit.log`
+
+## Service Status Monitoring
+Monitor service health through:
+- Windows Event Viewer
+- Service status in Windows Services
+- Log files in configured log directory
+
 ## Docker Installation
 
 Refer to the [Docker Operations](/dicom-capacitor/docker) page for instructions on how to run DICOM Capacitor in a Docker container.