Checkmarx

📋 Copy All Commands 📄 Generate PDF

Comprehensive checkmarx commands and workflows for system administration across all platforms.

Basic Commands

Command	Description
checkmarx --version	Show checkmarx version
checkmarx --help	Display help information
checkmarx init	Initialize checkmarx in current directory
checkmarx status	Check current status
checkmarx list	List available options
checkmarx info	Display system information
checkmarx config	Show configuration settings
checkmarx update	Update to latest version
checkmarx start	Start checkmarx service
checkmarx stop	Stop checkmarx service
checkmarx restart	Restart checkmarx service
checkmarx reload	Reload configuration

Installation

Linux/Ubuntu

# Package manager installation
sudo apt update
sudo apt install checkmarx

# Alternative installation
wget https://github.com/example/checkmarx/releases/latest/download/checkmarx-linux
chmod +x checkmarx-linux
sudo mv checkmarx-linux /usr/local/bin/checkmarx

# Build from source
git clone https://github.com/example/checkmarx.git
cd checkmarx
make && sudo make install

macOS

# Homebrew installation
brew install checkmarx

# MacPorts installation
sudo port install checkmarx

# Manual installation
curl -L -o checkmarx https://github.com/example/checkmarx/releases/latest/download/checkmarx-macos
chmod +x checkmarx
sudo mv checkmarx /usr/local/bin/

Windows

# Chocolatey installation
choco install checkmarx

# Scoop installation
scoop install checkmarx

# Winget installation
winget install checkmarx

# Manual installation
# Download from https://github.com/example/checkmarx/releases
# Extract and add to PATH

Configuration

Command	Description
checkmarx config show	Display current configuration
checkmarx config list	List all configuration options
checkmarx config set <key> <value>	Set configuration value
checkmarx config get <key>	Get configuration value
checkmarx config unset <key>	Remove configuration value
checkmarx config reset	Reset to default configuration
checkmarx config validate	Validate configuration file
checkmarx config export	Export configuration to file

Advanced Operations

File Operations

# Create new file/resource
checkmarx create <name>

# Read file/resource
checkmarx read <name>

# Update existing file/resource
checkmarx update <name>

# Delete file/resource
checkmarx delete <name>

# Copy file/resource
checkmarx copy <source> <destination>

# Move file/resource
checkmarx move <source> <destination>

# List all files/resources
checkmarx list --all

# Search for files/resources
checkmarx search <pattern>

Network Operations

# Connect to remote host
checkmarx connect <host>:<port>

# Listen on specific port
checkmarx listen --port <port>

# Send data to target
checkmarx send --target <host> --data "<data>"

# Receive data from source
checkmarx receive --source <host>

# Test connectivity
checkmarx ping <host>

# Scan network range
checkmarx scan <network>

# Monitor network traffic
checkmarx monitor --interface <interface>

# Proxy connections
checkmarx proxy --listen <port> --target <host>:<port>

Process Management

# Start background process
checkmarx start --daemon

# Stop running process
checkmarx stop --force

# Restart with new configuration
checkmarx restart --config <file>

# Check process status
checkmarx status --verbose

# Monitor process performance
checkmarx monitor --metrics

# Kill all processes
checkmarx killall

# Show running processes
checkmarx ps

# Manage process priority
checkmarx priority --pid <pid> --level <level>

Security Features

Authentication

# Login with username/password
checkmarx login --user <username>

# Login with API key
checkmarx login --api-key <key>

# Login with certificate
checkmarx login --cert <cert_file>

# Logout current session
checkmarx logout

# Change password
checkmarx passwd

# Generate new API key
checkmarx generate-key --name <key_name>

# List active sessions
checkmarx sessions

# Revoke session
checkmarx revoke --session <session_id>

Encryption

# Encrypt file
checkmarx encrypt --input <file> --output <encrypted_file>

# Decrypt file
checkmarx decrypt --input <encrypted_file> --output <file>

# Generate encryption key
checkmarx keygen --type <type> --size <size>

# Sign file
checkmarx sign --input <file> --key <private_key>

# Verify signature
checkmarx verify --input <file> --signature <sig_file>

# Hash file
checkmarx hash --algorithm <algo> --input <file>

# Generate certificate
checkmarx cert generate --name <name> --days <days>

# Verify certificate
checkmarx cert verify --cert <cert_file>

Monitoring and Logging

System Monitoring

# Monitor system resources
checkmarx monitor --system

# Monitor specific process
checkmarx monitor --pid <pid>

# Monitor network activity
checkmarx monitor --network

# Monitor file changes
checkmarx monitor --files <directory>

# Real-time monitoring
checkmarx monitor --real-time --interval 1

# Generate monitoring report
checkmarx report --type monitoring --output <file>

# Set monitoring alerts
checkmarx alert --threshold <value> --action <action>

# View monitoring history
checkmarx history --type monitoring

Logging

# View logs
checkmarx logs

# View logs with filter
checkmarx logs --filter <pattern>

# Follow logs in real-time
checkmarx logs --follow

# Set log level
checkmarx logs --level <level>

# Rotate logs
checkmarx logs --rotate

# Export logs
checkmarx logs --export <file>

# Clear logs
checkmarx logs --clear

# Archive logs
checkmarx logs --archive <archive_file>

Troubleshooting

Common Issues

Issue: Command not found

# Check if checkmarx is installed
which checkmarx
checkmarx --version

# Check PATH variable
echo $PATH

# Reinstall if necessary
sudo apt reinstall checkmarx
# or
brew reinstall checkmarx

Issue: Permission denied

# Run with elevated privileges
sudo checkmarx <command>

# Check file permissions
ls -la $(which checkmarx)

# Fix permissions
chmod +x /usr/local/bin/checkmarx

# Check ownership
sudo chown $USER:$USER /usr/local/bin/checkmarx

Issue: Configuration errors

# Validate configuration
checkmarx config validate

# Reset to default configuration
checkmarx config reset

# Check configuration file location
checkmarx config show --file

# Backup current configuration
checkmarx config export > backup.conf

# Restore from backup
checkmarx config import backup.conf

Issue: Service not starting

# Check service status
checkmarx status --detailed

# Check system logs
journalctl -u checkmarx

# Start in debug mode
checkmarx start --debug

# Check port availability
netstat -tulpn|grep <port>

# Kill conflicting processes
checkmarx killall --force

Debug Commands

Command	Description
checkmarx --debug	Enable debug output
checkmarx --verbose	Enable verbose logging
checkmarx --trace	Enable trace logging
checkmarx test	Run built-in tests
checkmarx doctor	Run system health check
checkmarx diagnose	Generate diagnostic report
checkmarx benchmark	Run performance benchmarks
checkmarx validate	Validate installation and configuration

Performance Optimization

Resource Management

# Set memory limit
checkmarx --max-memory 1G <command>

# Set CPU limit
checkmarx --max-cpu 2 <command>

# Enable caching
checkmarx --cache-enabled <command>

# Set cache size
checkmarx --cache-size 100M <command>

# Clear cache
checkmarx cache clear

# Show cache statistics
checkmarx cache stats

# Optimize performance
checkmarx optimize --profile <profile>

# Show performance metrics
checkmarx metrics

Parallel Processing

# Enable parallel processing
checkmarx --parallel <command>

# Set number of workers
checkmarx --workers 4 <command>

# Process in batches
checkmarx --batch-size 100 <command>

# Queue management
checkmarx queue add <item>
checkmarx queue process
checkmarx queue status
checkmarx queue clear

Integration

Scripting

#!/bin/bash
# Example script using checkmarx

set -euo pipefail

# Configuration
CONFIG_FILE="config.yaml"
LOG_FILE="checkmarx.log"

# Check if checkmarx is available
if ! command -v checkmarx &> /dev/null; then
    echo "Error: checkmarx is not installed" >&2
    exit 1
fi

# Function to log messages
log() \\\\{
    echo "$(date '+%Y-%m-%d %H:%M:%S') - $1"|tee -a "$LOG_FILE"
\\\\}

# Main operation
main() \\\\{
    log "Starting checkmarx operation"

    if checkmarx --config "$CONFIG_FILE" run; then
        log "Operation completed successfully"
        exit 0
    else
        log "Operation failed with exit code $?"
        exit 1
    fi
\\\\}

# Cleanup function
cleanup() \\\\{
    log "Cleaning up"
    checkmarx cleanup
\\\\}

# Set trap for cleanup
trap cleanup EXIT

# Run main function
main "$@"

API Integration

#!/usr/bin/env python3
"""
Python wrapper for the tool
"""

import subprocess
import json
import logging
from pathlib import Path
from typing import Dict, List, Optional

class ToolWrapper:
    def __init__(self, config_file: Optional[str] = None):
        self.config_file = config_file
        self.logger = logging.getLogger(__name__)

    def run_command(self, args: List[str]) -> Dict:
        """Run command and return parsed output"""
        cmd = ['tool_name']

        if self.config_file:
            cmd.extend(['--config', self.config_file])

        cmd.extend(args)

        try:
            result = subprocess.run(
                cmd,
                capture_output=True,
                text=True,
                check=True
            )
            return \\\\{'stdout': result.stdout, 'stderr': result.stderr\\\\}
        except subprocess.CalledProcessError as e:
            self.logger.error(f"Command failed: \\\\{e\\\\}")
            raise

    def status(self) -> Dict:
        """Get current status"""
        return self.run_command(['status'])

    def start(self) -> Dict:
        """Start service"""
        return self.run_command(['start'])

    def stop(self) -> Dict:
        """Stop service"""
        return self.run_command(['stop'])

# Example usage
if __name__ == "__main__":
    wrapper = ToolWrapper()
    status = wrapper.status()
    print(json.dumps(status, indent=2))

Environment Variables

Variable	Description	Default
CHECKMARX_CONFIG	Configuration file path	~/.checkmarx/config.yaml
CHECKMARX_HOME	Home directory	~/.checkmarx
CHECKMARX_LOG_LEVEL	Logging level	INFO
CHECKMARX_LOG_FILE	Log file path	~/.checkmarx/logs/checkmarx.log
CHECKMARX_CACHE_DIR	Cache directory	~/.checkmarx/cache
CHECKMARX_DATA_DIR	Data directory	~/.checkmarx/data
CHECKMARX_TIMEOUT	Default timeout	30s
CHECKMARX_MAX_WORKERS	Maximum workers	4

Configuration File

# ~/.checkmarx/config.yaml
version: "1.0"

# General settings
settings:
  debug: false
  verbose: false
  log_level: "INFO"
  log_file: "~/.checkmarx/logs/checkmarx.log"
  timeout: 30
  max_workers: 4

# Network configuration
network:
  host: "localhost"
  port: 8080
  ssl: true
  timeout: 30
  retries: 3

# Security settings
security:
  auth_required: true
  api_key: ""
  encryption: "AES256"
  verify_ssl: true

# Performance settings
performance:
  cache_enabled: true
  cache_size: "100M"
  cache_dir: "~/.checkmarx/cache"
  max_memory: "1G"

# Monitoring settings
monitoring:
  enabled: true
  interval: 60
  metrics_enabled: true
  alerts_enabled: true

Examples

Basic Workflow

# 1. Initialize checkmarx
checkmarx init

# 2. Configure basic settings
checkmarx config set host example.com
checkmarx config set port 8080

# 3. Start service
checkmarx start

# 4. Check status
checkmarx status

# 5. Perform operations
checkmarx run --target example.com

# 6. View results
checkmarx results

# 7. Stop service
checkmarx stop

Advanced Workflow

# Comprehensive operation with monitoring
checkmarx run \
  --config production.yaml \
  --parallel \
  --workers 8 \
  --verbose \
  --timeout 300 \
  --output json \
  --log-file operation.log

# Monitor in real-time
checkmarx monitor --real-time --interval 5

# Generate report
checkmarx report --type comprehensive --output report.html

Automation Example

#!/bin/bash
# Automated checkmarx workflow

# Configuration
TARGETS_FILE="targets.txt"
RESULTS_DIR="results/$(date +%Y-%m-%d)"
CONFIG_FILE="automation.yaml"

# Create results directory
mkdir -p "$RESULTS_DIR"

# Process each target
while IFS= read -r target; do
    echo "Processing $target..."

    checkmarx \
        --config "$CONFIG_FILE" \
        --output json \
        --output-file "$RESULTS_DIR/$\\\\{target\\\\}.json" \
        run "$target"

done < "$TARGETS_FILE"

# Generate summary report
checkmarx report summary \
    --input "$RESULTS_DIR/*.json" \
    --output "$RESULTS_DIR/summary.html"

Best Practices

Security

• Always verify checksums when downloading binaries
• Use strong authentication methods (API keys, certificates)
• Regularly update to the latest version
• Follow principle of least privilege
• Enable audit logging for compliance
• Use encrypted connections when possible
• Validate all inputs and configurations
• Implement proper access controls

Performance

• Use appropriate resource limits for your environment
• Monitor system performance regularly
• Optimize configuration for your use case
• Use parallel processing when beneficial
• Implement proper caching strategies
• Regular maintenance and cleanup
• Profile performance bottlenecks
• Use efficient algorithms and data structures

Operational

• Maintain comprehensive documentation
• Implement proper backup strategies
• Use version control for configurations
• Monitor and alert on critical metrics
• Implement proper error handling
• Use automation for repetitive tasks
• Regular security audits and updates
• Plan for disaster recovery

Development

• Follow coding standards and conventions
• Write comprehensive tests
• Use continuous integration/deployment
• Implement proper logging and monitoring
• Document APIs and interfaces
• Use version control effectively
• Review code regularly
• Maintain backward compatibility

Resources

Official Documentation

• Official Website
• Documentation
• API Reference
• Installation Guide
• Configuration Reference

Community Resources

• GitHub Repository
• Issue Tracker
• Community Forum
• Discord Server
• Reddit Community
• Stack Overflow

Learning Resources

• Getting Started Guide
• Tutorial Series
• Best Practices Guide
• Video Tutorials
• Training Courses
• Certification Program

Related Tools

• Git - Complementary functionality
• Docker - Alternative solution
• Kubernetes - Integration partner

---

Last updated: 2025-07-06|Edit on GitHub