Skip to main content

Scan repositories for scp.yaml files and build architecture graphs

Project description

SCP Constructor

Build architecture graphs from scp.yaml files. Scan local directories or GitHub organizations, validate manifests, sync to Neo4j, and export to JSON, Mermaid, or OpenC2 actuator profiles.

Installation

uv sync

Usage

Validate SCP Files

uv run scp-cli validate ./examples

Scan Local Directory

# Scan and export to Mermaid
uv run scp-cli scan ./path/to/repos --export mermaid

# Scan and export to JSON
uv run scp-cli scan ./path/to/repos --export json -o graph.json

# Scan and export OpenC2 actuator profile (for SOAR)
uv run scp-cli scan ./path/to/repos --export openc2 -o actuators.json

Transform JSON to Other Formats

# Scan once, transform many
uv run scp-cli scan ./repos --export json -o graph.json
uv run scp-cli transform graph.json --export mermaid -o diagram.mmd
uv run scp-cli transform graph.json --export openc2 -o actuators.json

Scan GitHub Organization

export GITHUB_TOKEN=ghp_xxx
uv run scp-cli scan-github myorg --export mermaid

Sync to Neo4j

export NEO4J_URI=bolt://localhost:7687
export NEO4J_USER=neo4j
export NEO4J_PASSWORD=password

uv run scp-cli scan ./repos

Commands

Command Description
scp-cli validate <path> Validate SCP files
scp-cli scan <path> Scan local directory
scp-cli scan-github <org> Scan GitHub org
scp-cli transform <json> Transform JSON to other formats
scp-cli version Show version

Export Formats

  • JSON: Graph with nodes/edges arrays
  • Mermaid: Flowchart diagram with tier styling
  • OpenC2: Actuator profile for SOAR integration

Environment Variables

Variable Description
GITHUB_TOKEN GitHub PAT for org scanning
NEO4J_URI Neo4j connection URI
NEO4J_USER Neo4j username
NEO4J_PASSWORD Neo4j password

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scp_constructor-0.2.0.tar.gz (33.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

scp_constructor-0.2.0-py3-none-any.whl (16.3 kB view details)

Uploaded Python 3

File details

Details for the file scp_constructor-0.2.0.tar.gz.

File metadata

  • Download URL: scp_constructor-0.2.0.tar.gz
  • Upload date:
  • Size: 33.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for scp_constructor-0.2.0.tar.gz
Algorithm Hash digest
SHA256 af8a6a4abd3b52859e37ee1bc146f7a820c8bee93dc23732b4f9fa1ead56209c
MD5 10c1cbf124ed20d9bc984caeb437cb1e
BLAKE2b-256 c666dbcb4220d3394c6ee7f3c896f73579d18f2184be27926c2b793dcbe69b75

See more details on using hashes here.

Provenance

The following attestation bundles were made for scp_constructor-0.2.0.tar.gz:

Publisher: ci.yml on krackenservices/scp-integrations

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file scp_constructor-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for scp_constructor-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 835f9e178ce4de6e142f150175466587f3e10db07b5b1ad672f1760eb0ace13f
MD5 d88e61de117558249154e8c46e014ddd
BLAKE2b-256 df297367eeb79f21fb6c24f4a6510d0276838304bce134f88f82213ca3206f9a

See more details on using hashes here.

Provenance

The following attestation bundles were made for scp_constructor-0.2.0-py3-none-any.whl:

Publisher: ci.yml on krackenservices/scp-integrations

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page