Command Palette

Search for a command to run...

UnylyUnyly
Browse all

Convoyplan

FreeNot checked

Defense logistics route/sustainment planner computing fuel, resupply windows, and chokepoint risk from a YAML plan.

GitHubEmbed

About

Defense logistics route/sustainment planner computing fuel, resupply windows, and chokepoint risk from a YAML plan.

README

CONVOYPLAN

CONVOYPLAN

Defense logistics route/sustainment planner computing fuel, resupply windows, and chokepoint risk from a YAML plan.

PyPI CI License: COCL 1.0 Suite

Part of the Cognis Neural Suite.

pip install cognis-convoyplan
convoyplan scan .            # → prioritized findings in seconds

🔎 Example output

Real, reproducible output from the tool — runs offline:

$ convoyplan-emit --version
convoyplan 0.1.0
$ convoyplan-emit --help
usage: convoyplan [-h] [--version] {plan} ...

Defense logistics route/sustainment planner: fuel, resupply windows, and
chokepoint risk from a YAML plan (analysis only).

positional arguments:
  {plan}
    plan      Compute sustainment for a convoy plan file.

options:
  -h, --help  show this help message and exit
  --version   show program's version number and exit

Blocks above are real convoyplan output — reproduce them from a clone.

Sample result format (illustrative values — run on your own data for real findings):

{
"findings": [
    {
        "id": "123456",
        "title": "Suspicious Activity Detected",
        "description": "Anomalous network traffic detected from IP 192.168.1.100",
        "type": "indicator",
        "created_at": "2023-02-20T14:30:00Z"
    },
    {
        "id": "789012",
        "title": "Malware Identified",
        "description": "Malware detected on host 192.168.1.101 with signature 'ABC123'",
        "type": "malware",
        "created_at": "2023-02-21T10:45:00Z"
    }
]
}

Usage — step by step

  1. Install:

    pip install -e .
    
  2. Write (or reuse) a YAML plan describing the mission, vehicles, fuel, and legs (distance/terrain/chokepoints).

  3. Compute sustainment with the plan subcommand:

    convoyplan plan mission.yaml
    

    The table reports total distance, fuel burn, usable fuel per vehicle, resupply count, and the max chokepoint risk, leg by leg, plus any WARNINGS.

  4. Get machine-readable output with --format json, and read the exit code: it is 0 when the plan is feasible and 1 when sustainment is infeasible (e.g. fuel runs out before a resupply):

    convoyplan plan mission.yaml --format json
    
  5. Use it in CI / planning gates — block an infeasible plan automatically:

    convoyplan plan mission.yaml --format json > plan.json || {
      echo "Convoy plan is INFEASIBLE — revisit fuel/resupply"; exit 1; }
    

Contents

Why convoyplan?

Defense logistics route/sustainment planner computing fuel, resupply windows, and chokepoint risk from a YAML plan. — without standing up heavyweight infrastructure.

convoyplan is single-purpose, scriptable, and self-hostable: point it at a target, get prioritized results in the format your workflow already speaks (table · JSON · SARIF), gate CI on it, and let agents drive it over MCP.

Features

  • ✅ Parse Plan
  • ✅ Load Plan
  • ✅ Chokepoint Risk
  • ✅ Plan Convoy
  • ✅ Runs on Linux/macOS/Windows · Docker · devcontainer
  • ✅ Ports in Python, JavaScript, Go, and Rust (ports/)

Quick start

pip install cognis-convoyplan
convoyplan --version
convoyplan scan .                       # scan current project
convoyplan scan . --format json         # machine-readable
convoyplan scan . --fail-on high        # CI gate (non-zero exit)

Example

$ convoyplan scan .
  [HIGH    ] CON-001  example finding             (./src/app.py)
  [MEDIUM  ] CON-002  another signal              (./config.yaml)

  2 findings · risk score 5 · 38ms

Architecture

flowchart LR
  IN[capture / scan] --> P[convoyplan<br/>parse + map]
  P --> OUT[report]

Use it from any AI stack

convoyplan is interoperable with every popular way of using AI:

  • MCP serverconvoyplan mcp (Claude Desktop, Cursor, Cognis.Studio, uncensored-fleet)
  • OpenAI-compatible / JSON — pipe convoyplan scan . --format json into any agent or LLM
  • LangChain · CrewAI · AutoGen · LlamaIndex — wrap the CLI/JSON as a tool in one line
  • CI / scripts — exit codes + SARIF for non-AI pipelines

How it compares

Cognis convoyplan typical tools
Self-hostable, no account varies
Single command, zero config ⚠️
JSON + SARIF for CI varies
MCP-native (AI agents)
Polyglot ports (JS/Go/Rust)
Open license ✅ COCL varies

Integrations

Pipes into your stack: SARIF for code-scanning, JSON for anything, an MCP server (convoyplan mcp) for AI agents, and a webhook forwarder for SIEM/Slack/Jira. See docs/INTEGRATIONS.md.

Install — every way, every platform

pip install "git+https://github.com/cognis-digital/convoyplan.git"    # pip (works today)
pipx install "git+https://github.com/cognis-digital/convoyplan.git"   # isolated CLI
uv tool install "git+https://github.com/cognis-digital/convoyplan.git" # uv
pip install cognis-convoyplan                                          # PyPI (when published)
docker run --rm ghcr.io/cognis-digital/convoyplan:latest --help        # Docker
brew install cognis-digital/tap/convoyplan                             # Homebrew tap
curl -fsSL https://raw.githubusercontent.com/cognis-digital/convoyplan/main/install.sh | sh
Linux macOS Windows Docker Cloud
scripts/setup-linux.sh scripts/setup-macos.sh scripts/setup-windows.ps1 docker run ghcr.io/cognis-digital/convoyplan DEPLOY.md (AWS/Azure/GCP/k8s)

Related Cognis tools

Explore the suite → 🗂️ all 170+ tools · ⭐ awesome-cognis · 🔗 cognis-sources · 🤖 uncensored-fleet · 🧠 engram

Contributing

PRs, new rules, and demo scenarios are welcome under the collaboration-pull model — see CONTRIBUTING.md and SECURITY.md.

⭐ If convoyplan saved you time, star it — it genuinely helps others find it.

Interoperability

{} composes with the 300+ tool Cognis suite — JSON in/out and a shared OpenAI-compatible /v1 backbone. See INTEROP.md for the suite map, composition patterns, and reference stacks.

License

Source-available under the Cognis Open Collaboration License (COCL) v1.0 — free for personal, internal-evaluation, research, and educational use; commercial / production use requires a license ([email protected]). See LICENSE.


Cognis Digital · one of 170+ tools in the Cognis Neural Suite · Making Tomorrow Better Today

from github.com/cognis-digital/convoyplan

Installing Convoyplan

This server has no published package — it is built from source. Open the repository and follow its README.

▸ github.com/cognis-digital/convoyplan

FAQ

Is Convoyplan MCP free?

Yes, Convoyplan MCP is free — one-click install via Unyly at no cost.

Does Convoyplan need an API key?

No, Convoyplan runs without API keys or environment variables.

Is Convoyplan hosted or self-hosted?

Self-hosted: the server runs locally on your machine via the install command above.

How do I install Convoyplan in Claude Desktop, Claude Code or Cursor?

Open Convoyplan on unyly.org, pick your client tab (Claude Desktop, Claude Code, Cursor) and press Install — the config is generated automatically, no JSON editing.

Related MCPs

Compare Convoyplan with

Not sure what to pick?

Find your stack in 60 seconds

Author?

Embed badge for your README

Browse similar

All development MCPs