You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: FUNCTIONAL_MANUAL.md
+28-8Lines changed: 28 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,7 +58,7 @@ Each card gives you an at-a-glance overview of a repository:
58
58
-**Delete (trash icon):** Removes the repository from the dashboard.
59
59
-**Remote URL & Local Path:** The repository's remote URL and local path, each with a copy-to-clipboard button.
60
60
-**Branch & Status Line:** A single line containing:
61
-
-**Branch Selector (Git only):** A dropdown to view and switch between branches.
61
+
-**Branch Selector:** A dropdown to view and switch between branches for both Git and SVN repositories. SVN users can move between the trunk and feature branches just like Git users, while destructive actions remain Git-specific.
62
62
-**Status Indicators:** At a glance, see if updates are available, how far ahead/behind the remote you are, and a summary of local file changes.
63
63
-**Metadata:**
64
64
-**Build Health:** The status of the last build (`Healthy`, `Failing`, `Unknown`).
@@ -69,8 +69,11 @@ Each card gives you an at-a-glance overview of a repository:
69
69
70
70
Each card has a set of action buttons at the bottom:
71
71
72
+
-**Setup & Clone / Clone Repo:** When the local working copy is missing, the card automatically surfaces guided buttons. **Setup & Clone** opens a folder picker so you can select where to place the checkout, then immediately kicks off the clone/checkout. If a path is already stored but empty, a single **Clone Repo** button runs the clone directly. Progress for both flows streams into the log panel.
72
73
-**Task Buttons:** Any task marked with "Show on dashboard" will appear as its own button for one-click execution.
74
+
-**Pinned Launch Buttons:** Launch configurations flagged to "Show on dashboard" appear alongside task buttons with a lightning icon for one-click app launches.
73
75
-**More Tasks (Play Icon):** If there are more tasks available, this button opens a modal to select any of the repository's tasks to run.
76
+
-**Launch Menu (Lightning Icon):** Opens an overflow menu listing unpinned launch configurations and auto-detected executables so you can start tools without leaving the dashboard.
74
77
-**Open in Terminal (Terminal Icon):** Opens the repository's local folder in your system's default terminal.
75
78
-**View Logs (Document Icon):** Opens the resizable log panel to show previous logs for this repository.
76
79
-**View History (Clock Icon):** Opens a modal displaying the commit history for this repository.
@@ -96,13 +99,20 @@ Tasks (automation scripts) are configured on a per-repository basis.
96
99
3. Fill in the repository's details (Name, URL, Local Path, VCS type, etc.). The **Local Path** must be the absolute path to the repository on your computer for real execution to work.
97
100
4. Click **"Save Repository"**.
98
101
102
+
#### First-Time Checkout Flow
103
+
104
+
If the saved repository path does not contain a working copy yet, the dashboard highlights the repository card with dedicated **Setup & Clone** controls. Use these buttons to pick a destination folder and trigger the clone (Git) or checkout (SVN) without leaving the app. The application streams the progress into the log panel so you can watch the operation complete before running any tasks.
105
+
99
106
### Editing a Repository and Managing Its Features
100
107
101
108
1. On the desired repository card, click the **pencil icon**.
102
109
2. The "Edit Repository" view will appear. For Git repositories, this is a multi-tab interface.
103
110
104
111
#### General Settings
105
-
This is the main panel where you configure the name, path, URL, and launch configurations for the repository.
112
+
This is the main panel where you configure the name, path, URL, and launch configurations for the repository. In addition to the basic metadata, this tab lets you:
113
+
114
+
-**Manage Launch Configurations:** Create launchers that either run a shell command or prompt for an executable to open. You can optionally capture command suggestions (pulled from the repo's detected project type), choose a working directory, and mark the launcher to **Show on dashboard** so it renders as a red lightning button on the repository card. Unpinned launchers remain available through the Launch menu on the card header and the card's right-click menu.
115
+
-**Control Dirty Repository Overrides:** The **Ignore Dirty Repository** checkbox bypasses the safety modal described later in this manual. Leave it unchecked to keep the protective prompts.
106
116
107
117
#### Tasks Tab
108
118
This is where you create powerful, custom automation scripts for the specific repository you are editing.
@@ -116,15 +126,25 @@ This is where you create powerful, custom automation scripts for the specific re
116
126
-**Environment Variables:** These are set as actual environment variables in the shell before commands are run. They can be used by scripts and build tools (e.g., `process.env.MY_VAR` in Node.js).
117
127
4. Continue adding, configuring, and re-ordering steps.
118
128
129
+
#### Dirty Repository Protection
130
+
131
+
Whenever you launch a task, the app checks the working tree for uncommitted changes. If it finds any, a **Dirty Repository** modal interrupts the run and lists the modified and untracked files. From this dialog you can:
132
+
133
+
-**Stash & Continue:** Save the changes to a temporary stash before running the task.
134
+
-**Ignore Selected & Push:** Choose specific untracked files to ignore, then continue. Behind the scenes this uses the shared `ignoreFilesAndPush` IPC handler so the same safety logic applies everywhere.
135
+
-**Pull Anyway:** Force the task to continue without stashing.
136
+
-**Cancel Task:** Abort the run and return to the dashboard.
137
+
138
+
If you absolutely trust a repository's automation, enable **Ignore Dirty Repository** on the General tab to skip the modal for that repo only.
139
+
119
140
#### History Tab (Git & SVN)
120
141
Displays a detailed list of commits or revisions, including the author, date, and full message. You can search through the history and load more commits as you scroll.
121
142
122
-
#### Branches Tab (Git Only)
123
-
Provides a full interface to manage your Git branches. You can:
124
-
- View all local and remote branches.
125
-
- Create a new branch.
126
-
- Delete local or remote branches.
127
-
- Merge another branch into your current one.
143
+
#### Branches Tab
144
+
Provides a unified interface to inspect branches for both Git and SVN repositories. The dropdown is backed by the shared `list-branches` IPC handler, so Git and SVN cards use the same data source on the dashboard.
145
+
146
+
-**Git Repositories:** View all local and remote branches, create or delete branches, and merge another branch into your current one.
147
+
-**SVN Repositories:** Browse available branches (including trunk) and switch the working copy. Destructive operations such as creating or deleting branches remain Git-only.
128
148
129
149
#### Releases Tab (Git Only)
130
150
This tab provides a complete interface for managing your project's GitHub releases. It requires a GitHub Personal Access Token to be configured in the global settings. To view and manage draft releases, the token must have repository permissions for **"Contents: Read & write"**.
Copy file name to clipboardExpand all lines: README.md
+6-2Lines changed: 6 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,16 +8,19 @@ This application provides a simple, powerful dashboard to manage and automate th
8
8
-**Centralized Dashboard:** View the status, branch, and build health of all your repositories in one place.
9
9
-**Customizable Dashboard Categories:** Organize your repositories into collapsible sections with **dual-theme (light/dark) color styling**, a library of predefined themes, full drag-and-drop support (for both repositories and categories), and alternative up/down reorder buttons.
10
10
-**Multi-VCS Support:** Manage both Git and Subversion (SVN) repositories seamlessly.
11
+
-**Guided Repository Setup:** Built-in **Setup & Clone** and **Clone Repo** actions help you create or repair local working copies directly from each repository card, streaming progress into the integrated log panel.
11
12
-**Repository-Specific Tasks:** Create custom, multi-step automation scripts (e.g., pull/update, install, build) for each repository.
-**Advanced Task Steps:** A rich library of specific, pre-built steps for different ecosystems—including Go, Rust, Java/Maven, and .NET—**now organized into logical categories in the UI for easy discovery**, simplifies creating complex workflows.
14
15
-**Task Environment Variables:** Define shell environment variables that are available to all command steps within a task.
16
+
-**Launch Shortcuts:** Configure reusable launchers for custom commands or executables, pin favorites to repository cards, and access the rest from a lightning-fast overflow menu or the right-click context menu.
15
17
-**Quick Actions:** Manually refresh repository state, copy URLs/paths with a single click, access all common actions via a right-click context menu, and reorder repositories with up/down buttons.
16
18
-**Powerful Command Palette:** Quickly access any action, task, or repository using the keyboard shortcut (`Ctrl/Cmd+K`) to open a powerful search-driven command modal.
17
19
-**Parallel Execution:** Run tasks on multiple repositories at the same time without waiting.
18
20
-**One-Click Update Check:** A "Check Updates" button fetches the latest information from all remotes, showing an "Updates Available" indicator on repositories that are behind.
19
21
-**Detailed VCS Status:** See ahead/behind status (Git) and a summary of file changes directly on the dashboard.
20
-
-**Branch Management (Git):** Quickly switch branches from the dashboard, or view, create, delete, and merge branches in the configuration view.
22
+
-**Branch Management:** Quickly switch branches from the dashboard. Git repositories can view, create, delete, and merge branches from the configuration view, while SVN repositories can browse branches/trunk and switch working copies.
23
+
-**Dirty Working Tree Safety:** Task runs are automatically paused when uncommitted changes are detected, giving you options to stash, force, or ignore selected files before continuing.
21
24
-**GitHub Release Management (Git):** See the latest release on the dashboard, and view, create, edit, and manage all your project's releases directly from the configuration view.
22
25
-**Commit History:** View the commit history for any Git or SVN repository, with **a stable, non-flickering UI**, search, and load-on-demand.
23
26
-**Tabbed & Integrated Log Panel:** Monitor the output of every command in a detailed, resizable, and tabbed log panel that integrates smoothly into the main view.
@@ -39,6 +42,7 @@ This application provides a simple, powerful dashboard to manage and automate th
39
42
- Select the Version Control System (Git or SVN).
40
43
- Fill in the required details on the "General" tab.
41
44
- Click **"Save Repository"**.
45
+
- If the local path is empty, use the **Setup & Clone** button on the new card to pick a folder and fetch the repository automatically.
42
46
43
47
2.**Create a Task:**
44
48
- On the dashboard, click the **pencil icon** on your repository's card to open the configuration modal.
@@ -49,7 +53,7 @@ This application provides a simple, powerful dashboard to manage and automate th
49
53
50
54
3.**Run a Task:**
51
55
- Find your repository card on the dashboard.
52
-
- Click a task button or use the task selection menu to run your task.
56
+
- Click a task button or use the task selection menu to run your task. If the working copy is dirty, the safety modal will appear with options to stash, ignore selected files, force the pull, or cancel.
53
57
- The resizable log panel will automatically appear at the bottom, showing the progress of your script.
0 commit comments