# philipstuessel/jap architecture

> Architecture diagram of the GitHub repository philipstuessel/jap, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/philipstuessel/jap
- Repository: https://github.com/philipstuessel/jap

## Overview

JAP is a modular terminal automation framework used through the `jap <command>` interface. Its repository separates command entry, shell workflow features, utilities, and UI/documentation resources; the README also describes extensibility through a plugin system. The README documents command invocation and help, but no source excerpts were provided, so internal dispatch and calls among modules cannot be verified and are not drawn. File responsibilities beyond their names are represented cautiously.

Main entry points: [`jap.zsh`](https://github.com/philipstuessel/jap/blob/main/jap.zsh) (JAP command), [`lib/docs/help`](https://github.com/philipstuessel/jap/blob/main/lib/docs/help) (Command help)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Command entry"]
  node_jap["JAP command<br/>[jap.zsh]"]
  node_core_init["Core initialization<br/>[init.zsh]"]
  node_config["Configuration<br/>[config.json]"]
  node_runs["Run definitions<br/>[runs.json]"]
end

subgraph group_shell["Shell workflows"]
  node_aliases["Aliases<br/>[aliases.zsh]"]
  node_fetch["Fetch workflow<br/>[fetch.zsh]"]
  node_navigation["Navigation<br/>[navigation.zsh]"]
  node_plugins["Plugin management<br/>[plugins.zsh]"]
  node_swap["Swap workflow<br/>[swap.zsh]"]
end

subgraph group_utilities["Utilities"]
  node_commands["Command utilities<br/>[commands.zsh]"]
  node_jip["JIP utility<br/>[jip.zsh]"]
  node_pull["Pull utility<br/>[pull.zsh]"]
  node_replace["Replace utility<br/>[replace.zsh]"]
  node_space["Space utility<br/>[space.zsh]"]
  node_ziper["ZIP utility<br/>[ziper.zsh]"]
end

subgraph group_interface["UI and help"]
  node_ui_colors["Terminal colors<br/>[colors.zsh]"]
  node_docs_colors["Help colors"]
  node_help["Command help"]
end

node_user(("Terminal user"))

node_user -->|"runs commands"| node_jap
node_jap -->|"shows help"| node_help

click node_jap "https://github.com/philipstuessel/jap/blob/main/jap.zsh"
click node_core_init "https://github.com/philipstuessel/jap/blob/main/lib/core/init.zsh"
click node_aliases "https://github.com/philipstuessel/jap/blob/main/lib/shell/aliases.zsh"
click node_fetch "https://github.com/philipstuessel/jap/blob/main/lib/shell/fetch.zsh"
click node_navigation "https://github.com/philipstuessel/jap/blob/main/lib/shell/navigation.zsh"
click node_plugins "https://github.com/philipstuessel/jap/blob/main/lib/shell/plugins.zsh"
click node_swap "https://github.com/philipstuessel/jap/blob/main/lib/shell/swap.zsh"
click node_commands "https://github.com/philipstuessel/jap/blob/main/lib/utils/commands.zsh"
click node_jip "https://github.com/philipstuessel/jap/blob/main/lib/utils/jip.zsh"
click node_pull "https://github.com/philipstuessel/jap/blob/main/lib/utils/pull.zsh"
click node_replace "https://github.com/philipstuessel/jap/blob/main/lib/utils/replace.zsh"
click node_space "https://github.com/philipstuessel/jap/blob/main/lib/utils/space.zsh"
click node_ziper "https://github.com/philipstuessel/jap/blob/main/lib/utils/ziper.zsh"
click node_ui_colors "https://github.com/philipstuessel/jap/blob/main/lib/ui/colors.zsh"
click node_docs_colors "https://github.com/philipstuessel/jap/blob/main/lib/docs/colors"
click node_help "https://github.com/philipstuessel/jap/blob/main/lib/docs/help"
click node_config "https://github.com/philipstuessel/jap/blob/main/config/config.json"
click node_runs "https://github.com/philipstuessel/jap/blob/main/config/runs.json"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_jap,node_core_init,node_config,node_runs,node_user toneBlue
class node_aliases,node_fetch,node_navigation,node_plugins,node_swap toneAmber
class node_commands,node_jip,node_pull,node_replace,node_space,node_ziper toneMint
class node_ui_colors,node_docs_colors,node_help toneRose
```

## Components

### Command entry

- [JAP command](https://github.com/philipstuessel/jap/blob/main/jap.zsh): `jap.zsh`
- [Core initialization](https://github.com/philipstuessel/jap/blob/main/lib/core/init.zsh): `lib/core/init.zsh`
- [Configuration](https://github.com/philipstuessel/jap/blob/main/config/config.json): `config/config.json`
- [Run definitions](https://github.com/philipstuessel/jap/blob/main/config/runs.json): `config/runs.json`

### Shell workflows

- [Aliases](https://github.com/philipstuessel/jap/blob/main/lib/shell/aliases.zsh): `lib/shell/aliases.zsh`
- [Fetch workflow](https://github.com/philipstuessel/jap/blob/main/lib/shell/fetch.zsh): `lib/shell/fetch.zsh`
- [Navigation](https://github.com/philipstuessel/jap/blob/main/lib/shell/navigation.zsh): `lib/shell/navigation.zsh`
- [Plugin management](https://github.com/philipstuessel/jap/blob/main/lib/shell/plugins.zsh): `lib/shell/plugins.zsh`
- [Swap workflow](https://github.com/philipstuessel/jap/blob/main/lib/shell/swap.zsh): `lib/shell/swap.zsh`

### Utilities

- [Command utilities](https://github.com/philipstuessel/jap/blob/main/lib/utils/commands.zsh): `lib/utils/commands.zsh`
- [JIP utility](https://github.com/philipstuessel/jap/blob/main/lib/utils/jip.zsh): `lib/utils/jip.zsh`
- [Pull utility](https://github.com/philipstuessel/jap/blob/main/lib/utils/pull.zsh): `lib/utils/pull.zsh`
- [Replace utility](https://github.com/philipstuessel/jap/blob/main/lib/utils/replace.zsh): `lib/utils/replace.zsh`
- [Space utility](https://github.com/philipstuessel/jap/blob/main/lib/utils/space.zsh): `lib/utils/space.zsh`
- [ZIP utility](https://github.com/philipstuessel/jap/blob/main/lib/utils/ziper.zsh): `lib/utils/ziper.zsh`

### UI and help

- [Terminal colors](https://github.com/philipstuessel/jap/blob/main/lib/ui/colors.zsh): `lib/ui/colors.zsh`
- [Help colors](https://github.com/philipstuessel/jap/blob/main/lib/docs/colors): `lib/docs/colors`
- [Command help](https://github.com/philipstuessel/jap/blob/main/lib/docs/help): `lib/docs/help`

### Other components

- **Terminal user**

## Connections

- Terminal user → JAP command: runs commands (evidence: `README.md`)
- JAP command → Command help: shows help (evidence: `README.md`)
