nexus-tui 0.1.14__py3-none-any.whl → 0.1.15__py3-none-any.whl

nexus_tui-0.1.15.dist-info/METADATA

@@ -0,0 +1,200 @@
+Metadata-Version: 2.4
+Name: nexus-tui
+Version: 0.1.15
+Summary: A TUI orchestrator to manage your installed terminal tools—access everything through a single command
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: platformdirs>=4.0.0
+Requires-Dist: pydantic>=2.12.5
+Requires-Dist: structlog>=24.1.0
+Requires-Dist: textual>=0.86.0
+Requires-Dist: thefuzz>=0.20.0
+Description-Content-Type: text/markdown
+
+# Nexus
+
+Nexus is a terminal dashboard that lets you launch your favorite CLI and TUI tools (like Neovim, Git UIs, or custom scripts) from a single interactive menu. No memorizing commands or directories required.
+
+Think of Nexus as a launcher for terminal tools, similar to how Raycast or Alfred launch GUI apps.
+
+**Source Code**: https://github.com/jdluu/Nexus
+
+![Nexus Logic Demo](docs/nexus_demo.png)
+*Caption: Main dashboard showing projects and tools.*
+
+## Prerequisites
+
+*   Python 3.12 or newer.
+*   The [`uv`](https://docs.astral.sh/uv/) package manager.
+*   **Recommended**: A modern terminal emulator with TrueColor support (e.g., [Windows Terminal](https://aka.ms/terminal), [ghostty](https://ghostty.org/), [Kitty](https://sw.kovidgoyal.net/kitty/), or [WezTerm](https://wezfurlong.org/wezterm/)).
+*   **Recommended**: A [Nerd Font](https://www.nerdfonts.com/) for optimal icon rendering.
+
+## Installation
+
+It is recommended to use `uv`, a fast Python package and tool manager (similar to pipx), for a clean, isolated global installation.
+
+```bash
+# Install globally so you can run 'nexus' from anywhere
+uv tool install nexus-tui
+```
+
+**Alternative (Standard pip)**:
+You can also install via pip, though it is recommended `uv` or `pipx` to keep dependencies isolated.
+```bash
+pip install nexus-tui
+```
+
+### Upgrade
+
+To update to the latest version:
+```bash
+uv tool upgrade nexus-tui
+```
+
+### Local Development
+
+For contributors who want to modify the source code:
+
+```bash
+git clone https://github.com/jdluu/Nexus
+cd Nexus
+uv tool install --editable .
+```
+
+## Cross Platform Support
+
+Nexus supports Linux, MacOS, and Windows.
+
+*   **Linux**: Fully supported on standard terminals.
+*   **MacOS**: Fully supported.
+*   **Windows**: Recommended to use PowerShell 7 or Git Bash within Windows Terminal.
+
+*Note: Some tools you launch may behave differently depending on your shell and operating system.*
+
+## Configuration
+
+Nexus utilizes standard configuration paths. You can find your config file at the location listed in the **First Run** section above.
+
+### Minimal Starter Config
+
+Copy this into your `tools.toml` to get started immediately:
+
+```toml
+# Define where your code projects live
+project_root = "~/Projects"
+
+# Add a simple tool to open a shell in the selected project
+[[tool]]
+label = "Shell"
+category = "UTIL"
+description = "Open a shell in the project"
+command = "$SHELL"
+requires_project = true
+```
+
+### Understanding "Projects"
+
+A **Project** is any directory found inside your `project_root`. Nexus scans this folder and lets you select a specific project before launching a tool.
+
+For example, if you select the "Shell" tool above, Nexus will ask you to pick a project (e.g., `~/Projects/MyApp`). It then launches `$SHELL` inside that directory.
+
+### Tool Definitions
+
+Tools are defined using the `[[tool]]` table.
+
+```toml
+[[tool]]
+label = "Neovim"
+category = "DEV"
+description = "Text editor"
+command = "nvim"
+requires_project = true
+```
+
+*   **label**: The display name.
+*   **category**: The grouping identifier (e.g., DEV, UTIL).
+*   **description**: A short explanation of the function.
+*   **command**: The executable command line instruction.
+*   **requires_project**: If `true`, Nexus prompts for a project before running. If `false`, it runs immediately in the current directory.
+
+### Keybindings
+
+Nexus comes with default keybindings (see **Controls** below). You can override them in the `[keybindings]` section of your config.
+
+```toml
+[keybindings]
+# Override default quit to Alt+Q
+quit = "alt+q"
+# Override favorite toggle
+toggle_favorite = "ctrl+f"
+```
+
+## First Run Experience
+
+1.  Run `nexus` from your terminal.
+2.  Nexus creates a default configuration file at:
+    *   **Linux**: `~/.config/nexus/tools.toml`
+    *   **MacOS**: `~/Library/Application Support/Nexus/tools.toml`
+    *   **Windows**: `%LOCALAPPDATA%\Nexus\tools.toml`
+3.  On first launch, you will see an empty dashboard.
+4.  Edit the configuration file (see below) to add your tools and project roots.
+5.  Restart Nexus to see your changes.
+
+### Features
+
+*   **Smart Search**: Instantly find what you need with fuzzy matching, so you don't have to remember exact names.
+*   **Persistence**: Nexus remembers your recent projects and favorite tools, so common workflows are always one keystroke away.
+*   **Favorites**: Pin your most-used tools to the top of the list for quick access.
+
+### Controls
+
+*   **Arrow Keys**: Navigate through lists.
+*   **Enter**: Confirm selection or launch tool.
+*   **Ctrl+F**: Toggle the favorite status of a tool.
+*   **TypeAnywhere**: Instantly filter lists by typing in the search bar.
+*   **Esc**: Reset the search filter.
+*   **Ctrl+B**: Go back (on picker screens).
+*   **Ctrl+C**: Exit the application.
+*   **Ctrl+H**: Show Help / Controls.
+
+## FAQ & Troubleshooting
+
+### Does Nexus discover tools automatically?
+No. You must define your tools in `tools.toml` so you have full control over what appears in your dashboard.
+
+### Is this a replacement for my shell?
+No. Nexus is a dashboard. When you launch a tool, it temporarily suspends itself to let the tool take over your terminal found. When the tool exits, Nexus returns.
+
+### My icons look broken (rectangles or question marks).
+This usually means you aren't using a **Nerd Font**.
+1.  Download a font from [Nerd Fonts](https://www.nerdfonts.com/).
+2.  Install it on your system.
+3.  Configure your terminal emulator to use that font.
+
+### I see a blank screen on launch.
+Check that your `tools.toml` file exists and has at least one valid `[[tool]]` entry. See the **Configuration** section for a minimal example.
+
+## Development (For Contributors)
+
+To configure the development environment:
+
+1.  Synchronize dependencies:
+    ```bash
+    uv sync
+    ```
+
+2.  Run the application locally:
+    ```bash
+    uv run nexus
+    ```
+
+3.  Execute the comprehensive test suite:
+    ```bash
+    uv run pytest --cov=nexus
+    ```
+
+4.  Perform static analysis and type checking:
+    ```bash
+    uv run ruff check .
+    uv run mypy .
+    ```

nexus_tui-0.1.15.dist-info/RECORD

@@ -0,0 +1,28 @@
+nexus/__init__.py,sha256=bti-BCTw_hFdmSoy8872Cikse7LxK1e0aN5SaabgwIg,37
+nexus/app.py,sha256=7Kp_LVdhihhsPnL_8q_U-WAggKC9hZFqzf5rXljQ37k,3184
+nexus/config.py,sha256=zsonhQ_lNeaJsWi68GY-i8k0AYgmugWH6sDE_aD8bIQ,5875
+nexus/container.py,sha256=lQA2WB1WqvW9Y8lbY2QUYkpDTtep1ts00XBD2d3JY70,1152
+nexus/logger.py,sha256=sRhNYYErXzPzZ84uLm7MLH6NJb6EAGKUijRF1AvnfeU,1337
+nexus/models.py,sha256=elqUVjMMxa2RZoETtxKJkTpRrpLuglP43mBOwVSbA0o,1100
+nexus/state.py,sha256=52E6KO_TJFT483NDL7RsGl3swwUWh29nvN9drIP2PxA,2676
+nexus/style.tcss,sha256=4z9vrdd0MdxRUuzo7ehlduFnfpbukVCGoZUyjp3hkLI,11176
+nexus/tools.toml,sha256=uYfBA7WMLAu6fPDRzB4p5ggk0aVTUpDPrxRrzLnGiMA,740
+nexus/screens/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nexus/screens/create_project.py,sha256=UBZp7qT2Of9NrHPlfKcaPnE0DWza7xyTxzFAYubZuQg,3512
+nexus/screens/error.py,sha256=LQOkb-rLHbcYCRPrBybuusABcf73RbwN9q_f3N2VqmE,1817
+nexus/screens/help.py,sha256=9oFzXQMYzdhBAizSRPI5FoJcq4Pn62QnUkJ8YUaeoro,1732
+nexus/screens/project_picker.py,sha256=LfxxkOIknfVbNBGBNXqmE5CmA2Fa6lOIyO7tsXcUKaI,10342
+nexus/screens/theme_picker.py,sha256=KZ_L2QYnv95bdJGd3PcQnb0QJe1sgr3EIXm7Vd-tz-8,3479
+nexus/screens/tool_selector.py,sha256=SHgNJVbDXxi5hXwRty9FEQTvfG0jbBLZ9i9YXoxp74Y,8561
+nexus/services/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nexus/services/executor.py,sha256=SqeZa6owOTc04dCvMChiWVsGOWnrO1YW2gUvT5m4Nuk,1494
+nexus/services/scanner.py,sha256=YTx6WQBAvERK3zfdkHfwfj0Ygj9ZL1idhO8JUr_IF4M,1311
+nexus/widgets/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nexus/widgets/footer.py,sha256=O0ez8SRn9I5ag0mBY5WAd2-rUEaLV2kScs8-BlUTfso,2899
+nexus/widgets/tool_browser.py,sha256=Rmdz5NAvHeegmjmYIiTpy0aqr1wkJDKcsMu96B1EUPQ,9359
+nexus/widgets/tool_list_item.py,sha256=gpPC34cTK-sJJRzr9-gUvmIpJaEvpC0Gj1rmQTKUuQA,5703
+nexus_tui-0.1.15.dist-info/METADATA,sha256=Zh35tz1Ui36ZyWCcYggiofk6o5aTTYBivIz7Gvk7of4,6457
+nexus_tui-0.1.15.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+nexus_tui-0.1.15.dist-info/entry_points.txt,sha256=FLWKPqsNYxxaU0JyVfJoKJDTrFtx-LJVPejbvUdnc6o,41
+nexus_tui-0.1.15.dist-info/licenses/LICENSE,sha256=gtmNw2nOOujPlKSYxW0EQC-cg2aSe--mVlMxElz5AmI,1062
+nexus_tui-0.1.15.dist-info/RECORD,,

nexus_tui-0.1.14.dist-info/METADATA

@@ -1,150 +0,0 @@
-Metadata-Version: 2.4
-Name: nexus-tui
-Version: 0.1.14
-Summary: A TUI orchestrator to manage your installed terminal tools—access everything through a single command
-License-File: LICENSE
-Requires-Python: >=3.12
-Requires-Dist: platformdirs>=4.0.0
-Requires-Dist: pydantic>=2.12.5
-Requires-Dist: structlog>=24.1.0
-Requires-Dist: textual>=0.86.0
-Requires-Dist: thefuzz>=0.20.0
-Description-Content-Type: text/markdown
-
-# Nexus
-
-Nexus is a TUI orchestrator designed to help you organize and launch your collection of terminal utilities. Instead of memorizing every tool's unique command, Nexus provides a centralized dashboard to discover and run your installed TUIs from a single, intuitive interface.
-
-## Prerequisites
-
-*   Python 3.12 or newer.
-*   The `uv` package manager.
-*   **Recommended**: A modern terminal emulator with TrueColor support (e.g., [Windows Terminal](https://aka.ms/terminal), [ghostty](https://ghostty.org/), [Kitty](https://sw.kovidgoyal.net/kitty/), or [WezTerm](https://wezfurlong.org/wezterm/)).
-*   **Recommended**: A [Nerd Font](https://www.nerdfonts.com/) for optimal icon rendering.
-
-## Installation
-
-Install Nexus globally using the `uv` tool manager:
-
-```bash
-# Always latest stable
-uv tool install nexus-tui
-```
-
-### Upgrade
-
-To update to the latest version:
-```bash
-uv tool upgrade nexus-tui
-```
-
-### Local Development
-
-```bash
-git clone https://github.com/jdluu/Nexus
-cd Nexus
-uv tool install --editable .
-```
-
-## Cross Platform Support
-
-Nexus supports Linux, MacOS, and Windows.
-
-*   **Linux**: Fully supported on standard terminals.
-*   **MacOS**: Fully supported.
-*   **Windows**: Recommended to use PowerShell 7 or Git Bash within Windows Terminal.
-
-## Configuration
-
-Nexus utilizes the standard configuration paths for your operating system.
-
-*   **Linux**: `~/.config/nexus/tools.toml`
-*   **MacOS**: `~/Library/Application Support/Nexus/tools.toml`
-*   **Windows**: `%LOCALAPPDATA%\Nexus\tools.toml`
-
-### Project Directory
-
-To define the workspace where Nexus looks for projects, add the `project_root` key to your configuration file.
-
-```toml
-# Example configuration
-project_root = "~/Development"
-```
-
-### Tool Definitions
-
-Tools are defined in the configuration file using the `[[tool]]` table.
-
-```toml
-[[tool]]
-label = "Neovim"
-category = "DEV"
-description = "Text editor"
-command = "nvim"
-requires_project = true
-```
-
-*   **label**: The display name.
-*   **category**: The grouping identifier (for example DEV, UTIL).
-*   **description**: A short explanation of the function.
-*   **command**: The executable command line instruction.
-*   **requires_project**: Indicates if the tool needs a working directory.
-
-### Keybindings
-
-Custom keybindings can be defined in the `[keybindings]` section.
-
-```toml
-[keybindings]
-quit = "alt+q"
-toggle_favorite = "ctrl+f"
-```
-
-## Usage
-
-Launch the application using the following command:
-
-```bash
-nexus
-```
-
-### Features
-
-*   **Smart Search**: Filter projects using fuzzy matching logic.
-*   **Persistence**: Automatically tracks recent projects and favorites.
-*   **Favorites**: Pin frequently used tools for quick access.
-
-### Controls
-
-*   **Arrow Keys**: Navigate through lists.
-*   **Enter**: Confirm selection or launch tool.
-*   **Ctrl+F**: Toggle the favorite status of a tool.
-*   **TypeAnywhere**: Instantly filter lists by typing in the search bar.
-*   **Esc**: Reset the search filter.
-*   **Ctrl+B**: Go back (on picker screens).
-*   **Ctrl+Q**: Exit the application.
-
-## Development
-
-To configure the development environment:
-
-1.  Synchronize dependencies:
-    ```bash
-    uv sync
-    ```
-
-2.  Run the application locally:
-    ```bash
-    uv run nexus
-    ```
-
-3.  Execute the comprehensive test suite:
-    ```bash
-    uv run pytest --cov=nexus
-    ```
-
-4.  Perform static analysis and type checking:
-    ```bash
-    uv run ruff check .
-    uv run mypy .
-    ```

nexus_tui-0.1.14.dist-info/RECORD

@@ -1,26 +0,0 @@
-nexus/__init__.py,sha256=bti-BCTw_hFdmSoy8872Cikse7LxK1e0aN5SaabgwIg,37
-nexus/app.py,sha256=7Kp_LVdhihhsPnL_8q_U-WAggKC9hZFqzf5rXljQ37k,3184
-nexus/config.py,sha256=VfLaUuQn31gD_IC6LTkK5FE5b84JzIwOKu0arG0Z8f0,5467
-nexus/container.py,sha256=lQA2WB1WqvW9Y8lbY2QUYkpDTtep1ts00XBD2d3JY70,1152
-nexus/logger.py,sha256=sRhNYYErXzPzZ84uLm7MLH6NJb6EAGKUijRF1AvnfeU,1337
-nexus/models.py,sha256=elqUVjMMxa2RZoETtxKJkTpRrpLuglP43mBOwVSbA0o,1100
-nexus/state.py,sha256=dmBnHpzws2aErG42LaZFLXcse_9EwecmZy2dFgot4Tw,2532
-nexus/style.tcss,sha256=7PIAYBF2m6L_QnqTyFYyNQThkHWN3pQds5zH52Hq-ho,10067
-nexus/tools.toml,sha256=uYfBA7WMLAu6fPDRzB4p5ggk0aVTUpDPrxRrzLnGiMA,740
-nexus/screens/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-nexus/screens/create_project.py,sha256=uVAQioL6C-3mtriQfvuylUD0kX3sYA0KWgM0yWvzF9M,3597
-nexus/screens/error.py,sha256=LQOkb-rLHbcYCRPrBybuusABcf73RbwN9q_f3N2VqmE,1817
-nexus/screens/help.py,sha256=lG6Lkt-t3kPGcbltKZiFfv5S5d57ZiZkU4cc_jfM3Nw,1697
-nexus/screens/project_picker.py,sha256=ghXHKRLd4fxP8LWASi6_C8_BzEZFv266bsD591OSEyQ,9590
-nexus/screens/theme_picker.py,sha256=KZ_L2QYnv95bdJGd3PcQnb0QJe1sgr3EIXm7Vd-tz-8,3479
-nexus/screens/tool_selector.py,sha256=Q2ZeCxxifiyvScxwF4-Ke3sCM0ZolHODpfsIHHp9A-c,19038
-nexus/services/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-nexus/services/executor.py,sha256=SqeZa6owOTc04dCvMChiWVsGOWnrO1YW2gUvT5m4Nuk,1494
-nexus/services/scanner.py,sha256=YTx6WQBAvERK3zfdkHfwfj0Ygj9ZL1idhO8JUr_IF4M,1311
-nexus/widgets/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-nexus/widgets/tool_list_item.py,sha256=H0C04ef4OreL9vmyiku3hTA0SAXLoKWoGagIMn73jpI,5880
-nexus_tui-0.1.14.dist-info/METADATA,sha256=yVod_20wGc0w--UitU8sR5KpOltuv4Lv6TTNdQELFEI,3861
-nexus_tui-0.1.14.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-nexus_tui-0.1.14.dist-info/entry_points.txt,sha256=FLWKPqsNYxxaU0JyVfJoKJDTrFtx-LJVPejbvUdnc6o,41
-nexus_tui-0.1.14.dist-info/licenses/LICENSE,sha256=gtmNw2nOOujPlKSYxW0EQC-cg2aSe--mVlMxElz5AmI,1062
-nexus_tui-0.1.14.dist-info/RECORD,,