gws

https://github.com/streakycobra/gws
Admin
gws is a simple, bash-based, colorful helper tool for managing workspaces composed of multiple Git...
Tokens:20,075
Snippets:273
Trust Score:9.1
License:MIT
Update:2 months ago
Show doc for...
Tokens:
Raw
### Initial Workspace Setup

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/usage-patterns.md

Creates a reproducible workspace repository that can be versioned and shared.

```bash
# 1. Create workspace repository
git init ~/dev
cd ~/dev

# 2. Create projects list
cat > .projects.gws << 'EOF'
project-a | https://github.com/user/project-a.git
project-b | https://github.com/user/project-b.git
EOF

# 3. Create gitignore for workspace
cat > .gitignore << 'EOF'
*
!.projects.gws
!.ignore.gws
!.gitignore
EOF

# 4. Commit workspace configuration
git add .projects.gws .gitignore
git commit -m "Initial workspace setup"

# 5. Clone all projects
gws update

# 6. Push to remote for sharing
git remote add origin git@github.com:user/my-workspace.git
git push -u origin main
```

--------------------------------

### Remote Configuration String Examples

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/types.md

Examples of formatted strings used for defining multiple git remotes.

```bash
# Single remote (origin only)
"origin|https://github.com/user/repo.git, "

# Two remotes (origin + upstream)
"origin|https://github.com/user/repo.git, upstream|https://github.com/org/repo.git, "

# Three remotes
"origin|git@github.com:user/repo.git, upstream|https://github.com/upstream.git, fork|git@github.com:fork.git, "
```

--------------------------------

### Project Path Examples

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/types.md

Valid relative directory paths used for workspace organization.

```bash
work/project
personal/tools/utility
contrib/gws
deep/nested/path/to/repo
```

--------------------------------

### Handle Workspace Initialization Errors

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/errors.md

Examples of errors encountered when initializing or checking workspace status.

```bash
$ cd /tmp
$ gws status
Not in a workspace

$ gws init      # Creates .projects.gws
```

```bash
$ cd ~/dev
$ gws init
Already a workspace.
# Use a different directory, or edit .projects.gws directly
```

--------------------------------

### Define projects in .projects.gws

Source: https://github.com/streakycobra/gws/blob/master/README.md

Example format for the .projects.gws file defining project paths and their corresponding Git repository URLs.

```text
# Work related
work/tools/q | https://github.com/harelba/q.git

# Other
contrib/gws  | https://github.com/StreakyCobra/gws.git
contrib/peru | https://github.com/buildinspace/peru
```

--------------------------------

### Repository Name Display Format

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/errors.md

Example of how project paths are displayed in the status output.

```text
work/project1
  * main : Dirty (Uncached changes)

contrib/gws
  * master : Clean
```

--------------------------------

### Example workspace directory structure

Source: https://github.com/streakycobra/gws/blob/master/README.md

Visual representation of a typical workspace directory containing multiple Git repositories.

```text
dev
├── archlinux
│   ├── aur
│   └── habs
├── perso
│   ├── gws
│   ├── imaxplore
│   └── teafree
└── config
```

--------------------------------

### Run workspace check commands

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/commands.md

Examples of running the check command on the entire workspace or a specific subdirectory.

```bash
# Check workspace consistency
gws check

# Check specific subdirectory only
gws check work/
```

--------------------------------

### Branch Status Line Output

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/errors.md

Example output showing branch status, sync status, and local-only repository indicators.

```bash
work/project1
  * feature/new-ui : Dirty (Uncommitted changes) Not up to date
  
  * main : Clean

contrib/gws
  * master : Clean [Local only repository]

personal/archived
  Missing repository
```

--------------------------------

### Ignore Pattern Examples

Source: https://github.com/streakycobra/gws/blob/master/README.md

Examples of regular expressions for .ignore.gws.

```text
^work/
```

```text
-work$
```

```text
a
```

--------------------------------

### Define custom theme file

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/project-management.md

Example content for a theme file that redefines color variables using ANSI escape sequences.

```bash
# ~/.theme.gws
C_ERROR="\e[31m"          # Red
C_CLEAN="\e[32m"          # Green
C_NOT_SYNC="\e[33m"        # Yellow
C_REPO="\e[34m"            # Blue
C_BRANCH="\e[35m"          # Magenta
C_LOGS="\e[36m"            # Cyan
C_OFF="\e[0m"              # Reset
```

--------------------------------

### Git Remote Name Examples

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/types.md

Valid identifiers for git remotes.

```bash
origin
upstream
fork
mirror
company
my-upstream
```

--------------------------------

### Handle Repository Operation Failures

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/errors.md

Examples of output from failed git operations during cloning or repository management.

```bash
$ gws clone
work/project1
fatal: 'https://github.com/user/project1.git/' not found in upstream origin
Clone failed for work/project1
```

```bash
fatal: unable to read '/path/to/repo/.git/HEAD': Permission denied
```

--------------------------------

### Get Current Branch

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/git-operations.md

Retrieves the current branch name of a repository and prints it to stdout.

```bash
git_branch <directory>
```

```bash
current_branch=$(git_branch "work/project")
echo "Currently on branch: $current_branch"
```

--------------------------------

### cmd_init()

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/commands.md

Initializes a workspace by detecting existing Git repositories and creating a .projects.gws configuration file.

```APIDOC
## cmd_init()

### Description
Initializes a workspace by detecting existing Git repositories and creating a .projects.gws file in the current directory.

### Parameters
- None (operates on current directory)

### Returns
- 0: Success - .projects.gws created
- 1: Failure - already a workspace or no repositories found

### Example
```bash
gws init
```
```

--------------------------------

### Initialize workspace with gws

Source: https://github.com/streakycobra/gws/blob/master/README.md

Commands to automatically detect existing repositories and generate a .projects.gws file.

```bash
$ cd path/to/your/workspace
$ gws init
```

--------------------------------

### Initialize Workspace

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/errors.md

Shows the success message after running the initialization command.

```bash
$ gws init
Workspace file «.projects.gws» created.
```

--------------------------------

### Manual Configuration

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/usage-patterns.md

Defines projects explicitly in the .projects.gws file with support for multiple remotes.

```bash
cd ~/workspace
cat > .projects.gws << 'EOF'
# Work projects
work/service-a | https://github.com/company/service-a.git
work/service-b | https://github.com/company/service-b.git | https://github.com/company/service-b-mirror.git

# Personal projects
personal/tool | git@github.com:user/tool.git | https://github.com/user/tool.git upstream

# Contributed projects
contrib/framework | https://github.com/framework/core.git | git@github.com:me/framework.git my-fork
EOF
```

--------------------------------

### Initialize GWS Workspace

Source: https://github.com/streakycobra/gws/blob/master/README.md

Detects existing repositories to generate the initial project list.

```bash
$ gws init
```

--------------------------------

### Create custom theme configuration

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/project-management.md

Commands to create a new theme file in the user's configuration directory.

```bash
# Create custom theme
mkdir -p ~/.config/gws
cat > ~/.config/gws/theme << 'EOF'
C_ERROR="\e[91m"      # Bright red
C_CLEAN="\e[92m"      # Bright green
C_NOT_SYNC="\e[93m"   # Bright yellow
C_OFF="\e[0m"
EOF
```

--------------------------------

### Adding New Project

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/usage-patterns.md

Adds a repository to an existing workspace.

```bash
# 1. Edit .projects.gws
vim .projects.gws
# Add: new/project | https://github.com/user/project.git

# 2. Clone new project
gws clone new/project

# 3. Verify
gws status
```

--------------------------------

### Project Configuration Syntax

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/OVERVIEW.md

Defines the structure for the .projects.gws file, supporting multiple remotes and optional naming.

```text
<path> | <url1> [<name1>] [ | <url2> [<name2>] [ | ... ]]
```

--------------------------------

### Cloning on New Computer

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/usage-patterns.md

Replicates an existing workspace configuration on a new machine.

```bash
# 1. Clone workspace repository
git clone git@github.com:user/my-workspace.git ~/dev
cd ~/dev

# 2. Clone all managed projects
gws update

# 3. Check status
gws status
```

--------------------------------

### Register a project with add_project

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/project-management.md

Registers a project path and its remote configuration into the global projects associative array.

```bash
add_project <project_path> <remote_configuration>
```

```bash
# Add a new project (unusual - normally done via .projects.gws)
add_project "new/repo" "origin|https://github.com/user/new.git, "
```

--------------------------------

### Access Projects Associative Array

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/types.md

Retrieves the full configuration string or extracts the origin URL for a specific project path.

```bash
# Get complete remote config
config="${projects[$path]}"

# Extract origin URL
origin_url=$(get_repo_url "${projects[$path]}")
```

--------------------------------

### Initialize a Workspace

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/usage-patterns.md

Auto-detects existing Git repositories to create a new workspace configuration.

```bash
# Create workspace directory
mkdir -p ~/dev
cd ~/dev

# Detect and initialize
gws init

# Review created configuration
cat .projects.gws
```

--------------------------------

### Display Version Information

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/errors.md

Shows the output format for the version command.

```bash
$ gws --version
gws version 0.2.0
```

--------------------------------

### Display project file structure

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/INDEX.md

Visual representation of the project directory layout.

```text
output/
├── INDEX.md                          (this file - navigation and summary)
├── README.md                         (entry point and overview)
├── OVERVIEW.md                       (detailed project overview)
├── configuration.md                  (all config file formats)
├── types.md                          (data structures and formats)
├── errors.md                         (error catalog and diagnostics)
├── usage-patterns.md                 (practical examples)
└── api-reference/
    ├── commands.md                   (public commands - 5 functions)
    ├── git-operations.md             (git wrappers - 14 functions)
    └── project-management.md         (config mgmt - 6 functions)
```

--------------------------------

### Automate Workspace State Snapshots

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/usage-patterns.md

Capture the current status and configuration of a workspace into a versioned text file.

```bash
#!/bin/bash
# save_workspace_state.sh

WORKSPACE_ROOT=$(pwd)
TIMESTAMP=$(date +%Y%m%d_%H%M%S)
STATE_FILE="workspace_state_$TIMESTAMP.txt"

echo "Workspace State - $TIMESTAMP" > "$STATE_FILE"
echo "==============================" >> "$STATE_FILE"
echo "" >> "$STATE_FILE"

echo "Projects Status:" >> "$STATE_FILE"
gws status >> "$STATE_FILE" 2>&1

echo "" >> "$STATE_FILE"
echo "Configuration:" >> "$STATE_FILE"
cat .projects.gws >> "$STATE_FILE"

git add "$STATE_FILE"
git commit -m "Workspace snapshot: $TIMESTAMP"
```

--------------------------------

### Configure Workspace Repository as Container

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/usage-patterns.md

Structure a workspace as a Git repository to track configuration and ignore rules alongside project directories.

```bash
# Structure:
# workspace/
#   .git/                    ← workspace container repo
#   .projects.gws            ← workspace config
#   .ignore.gws              ← local ignore rules
#   project-1/               ← actual project (also .git)
#   project-2/               ← actual project (also .git)
#   archived/
#     project-3/             ← old project
```

```bash
# In workspace/.projects.gws
project-1 | https://github.com/user/project-1.git
project-2 | https://github.com/user/project-2.git
archived/project-3 | https://github.com/user/project-3.git

# In workspace/.gitignore
*
!.projects.gws
!.ignore.gws
!.gitignore
!.git/                       # Keep the workspace container
```

--------------------------------

### Define repositories in .projects.gws

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/README.md

Configure workspace repositories using a pipe-delimited format specifying the local path, repository URL, and optional remote names.

```bash
# Work related
work/tools/q | https://github.com/harelba/q.git
work/app | https://github.com/company/app.git | https://github.com/company/app-mirror.git mirror

# Personal
personal/tool | git@github.com:user/tool.git | https://github.com/user/tool.git upstream

# Contributed
contrib/gws | https://github.com/StreakyCobra/gws.git
```

--------------------------------

### Parse project configuration with read_projects

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/project-management.md

Parses the .projects.gws file to populate global project data structures and updates the cache.

```bash
read_projects()
```

```bash
path/to/repo1 | https://github.com/user/repo1.git
path/to/repo2 | https://github.com/user/repo2.git origin | https://github.com/upstream/repo2.git upstream
```

```bash
origin|<url>, upstream|<url>, custom|<url>, 
```

```bash
# Manually trigger project re-parsing
read_projects
echo "Found ${#projects[@]} projects"
for path in "${projects_indexes[@]}"; do
    echo "Project: $path"
done
```

--------------------------------

### Clone repositories with cmd_clone

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/commands.md

Clones repositories listed in .projects.gws, either selectively or all at once.

```bash
cmd_clone() [<project_path> ...]
```

```bash
# Clone all projects from projects list
gws clone

# Clone specific project only
gws clone work/tools/q

# Clone multiple specific projects
gws clone work/tools/q contrib/gws
```

--------------------------------

### Validate Configuration File

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/usage-patterns.md

Checks the .projects.gws file for syntax errors, such as missing separators or invalid spaces in paths.

```bash
#!/bin/bash
# validate_config.sh

echo "Validating .projects.gws"
echo ""

ERRORS=0

while read -r line; do
    # Skip comments and empty lines
    [[ "$line" =~ ^#.*$ ]] && continue
    [[ -z "$line" ]] && continue
    
    # Check syntax
    if ! echo "$line" | grep -q '|'; then
        echo "ERROR: Missing separator in: $line"
        ((ERRORS++))
        continue
    fi
    
    PATH=$(echo "$line" | cut -d'|' -f1 | sed 's/^[[:space:]]*//;s/[[:space:]]*$//')
    
    # Check for spaces in path
    if echo "$PATH" | grep -q ' '; then
        echo "ERROR: Path contains spaces: $PATH"
        ((ERRORS++))
    fi
done < .projects.gws

if [[ $ERRORS -eq 0 ]]; then
    echo "✓ Configuration valid"
else
    echo "✗ Found $ERRORS errors"
    exit 1
fi
```

--------------------------------

### Handling Multiple Remotes

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/usage-patterns.md

Configures and manages projects with multiple upstream or fork remotes.

```bash
# Project with multiple remotes
cat >> .projects.gws << 'EOF'
contrib/fork | https://github.com/official/project.git | git@github.com:me/project.git fork | https://github.com/other/project.git other
EOF

# Clone project (sets up all remotes)
gws clone contrib/fork

# View configured remotes
cd contrib/fork && git remote -v

# Fetch from all
git fetch --all

# Fast-forward from official
git merge --ff-only origin/main

# Merge in fork's work
git merge fork/feature-branch
```

--------------------------------

### Perform Workspace Health Checks

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/usage-patterns.md

Verify configuration existence, repository status, and environment requirements.

```bash
#!/bin/bash
# check_workspace_health.sh

echo "=== Workspace Health Check ==="
echo ""

echo "1. Checking workspace configuration"
if [[ -f .projects.gws ]]; then
    echo "   ✓ .projects.gws exists"
    echo "   Configured projects: $(grep -v '^#\|^$' .projects.gws | wc -l)"
else
    echo "   ✗ .projects.gws missing"
fi

echo ""
echo "2. Repository status"
gws check | head -20

echo ""
echo "3. Git operations check"
if command -v git &> /dev/null; then
    echo "   ✓ git installed ($(git --version | cut -d' ' -f3))"
else
    echo "   ✗ git not found"
fi

echo ""
echo "4. Bash version"
echo "   Bash ${BASH_VERSION} (required: > 4.0)"
if [[ ${BASH_VERSINFO[0]} -lt 4 ]]; then
    echo "   ✗ Bash version too old"
else
    echo "   ✓ Bash version OK"
fi
```

--------------------------------

### Invoke read_theme function

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/project-management.md

Executes the theme loading logic which checks for configuration files in standard locations.

```bash
read_theme()
```

--------------------------------

### Define Projects in .projects.gws

Source: https://github.com/streakycobra/gws/blob/master/README.md

Format for defining project paths and their associated Git remote URLs.

```text
work/theSoftware | git@github.com:You/theSoftware.git
perso/gws        | git@github.com:You/gws.git         | git@github.com:StreakyCobra/gws.git
```

--------------------------------

### Define projects in .projects.gws

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/configuration.md

Defines workspace repositories and their remotes. Each line represents a project with its path and one or more remote URLs.

```bash
# Simple two-repo workspace with only origin
work/project-a | https://github.com/company/project-a.git
work/project-b | https://github.com/company/project-b.git

# Project with upstream remote
contrib/gws | https://github.com/myuser/gws.git | https://github.com/StreakyCobra/gws.git

# Project with explicit remote names
personal/app | git@github.com:user/app.git origin | git@github.com:upstream/app.git upstream

# Project with multiple remotes
work/fork | https://github.com/me/repo.git origin | https://github.com/official/repo.git official | https://github.com/fork1/repo.git contributor

# Comments
# Work-related projects
work/tools/q | https://github.com/harelba/q.git

# Inline comments not supported for remotes (text after # in remote field is lost)
# personal/doc | https://github.com/user/doc.git  # This comment will be ignored
```

--------------------------------

### Extract repository URL with get_repo_url

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/project-management.md

Parses a serialized remote configuration string to retrieve and print the origin URL to stdout.

```bash
get_repo_url <remote_configuration_string>
```

```bash
# Get URL for a project
url=$(get_repo_url "${projects[work/tools/q]}")
echo "Origin URL: $url"

# In status check with optional origin
if url=$(get_repo_url "${projects[$dir]}"); then
    echo "Repository has origin: $url"
else
    echo "Local-only repository (no origin)"
fi
```

--------------------------------

### read_theme()

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/project-management.md

Loads and applies color theme configuration for terminal output. It searches for theme files in specific locations and sources them if the output is a terminal.

```APIDOC
## read_theme()

### Description
Loads and applies color theme configuration. If the output is a terminal, it searches for a theme file in .git/theme.gws, ${HOME}/.theme.gws, or ${HOME}/.config/gws/theme and sources the first one found. If not a terminal, it disables all colors.

### Parameters
- None

### Returns
- None

### Theme File Format
A shell script that redefines color variables such as C_ERROR, C_CLEAN, C_NOT_SYNC, C_REPO, C_BRANCH, C_LOGS, and C_OFF.
```

--------------------------------

### Use Branches Array

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/types.md

Populates and iterates over the global branches array.

```bash
git_branches "work/project"
# branches array now contains all local branch names
for branch in "${branches[@]}"; do
    echo "Branch: $branch"
done
```

--------------------------------

### Monochrome Theme Configuration

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/configuration.md

Set variables to empty strings to disable color output.

```bash
# ~/.theme.gws for no-color output
C_ERROR=""
C_NOT_SYNC=""
C_VERSION=""
C_HELP_PROGNAME=""
C_CLEAN=""
C_HELP_DIR=""
C_NO_REMOTE=""
C_REPO=""
C_BRANCH=""
C_LOGS=""
C_OFF=""
```

--------------------------------

### Perform Manual Diagnostics

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/errors.md

Commands to verify the workspace root, inspect internal variables after execution, and test git operations manually.

```bash
pwd
ls -la .projects.gws
```

```bash
# After running any command (populates cache)
source .cache.gws
declare -p projects_indexes
declare -p ignored_patterns
```

```bash
cd work/project
git fetch
git branch
git status
```

--------------------------------

### Fix Missing Remote Name Configuration

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/errors.md

Syntax correction for .projects.gws when defining multiple remote repositories.

```bash
# Before (error):
work/repo | url1 | url2 | url3

# After (fixed):
work/repo | url1 | url2 | url3 upstream2
```

```bash
$ gws status
The URL at position 3 for "work/repo" is missing a name.
```

--------------------------------

### Fast-Forward Merge Workflow

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/usage-patterns.md

Updates all repositories to their origin state using fast-forward merges.

```bash
# Fast-forward all branches to origin
gws ff

# Check result (should show all Clean)
gws status

# If conflicts occur, handle per-repository:
cd work/conflicted-project
git merge --abort
# or resolve manually
git status
```

--------------------------------

### cmd_clone()

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/commands.md

Selectively clones repositories defined in the .projects.gws configuration file.

```APIDOC
## cmd_clone()

### Description
Selectively clones specified repositories from the projects list. If no paths are provided, it displays all available projects.

### Parameters
- **project_path** (string) - Optional - One or more project paths from .projects.gws to clone.

### Returns
- 0: All clones successful
- Non-zero: At least one clone failed

### Example
```bash
# Clone all projects
gws clone

# Clone specific project
gws clone work/tools/q
```
```

--------------------------------

### Handle Nonexistent Directory Errors

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/errors.md

Demonstrates the error message returned when an invalid directory path is provided as an argument.

```bash
$ gws status nonexistent/
The directory 'nonexistent/' does not exist.

$ gws status work/      # Correct usage
```

--------------------------------

### Diagnose Clone Failures

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/usage-patterns.md

Use this script to verify repository URLs and test git access for a specific project path.

```bash
#!/bin/bash
# debug_clone.sh

PROJECT=$1

if [[ -z "$PROJECT" ]]; then
    echo "Usage: $0 <project_path>"
    exit 1
fi

echo "Debugging clone for: $PROJECT"
echo ""

# Get the URL
URL=$(grep "^$PROJECT " .projects.gws | cut -d'|' -f2 | sed 's/^[[:space:]]*//;s/[[:space:]]*$//')

echo "URL: $URL"
echo ""

# Test git access
echo "Testing git access:"
git ls-remote "$URL" HEAD || echo "ERROR: Cannot access repository"

# Try clone
echo ""
echo "Attempting clone:"
git clone "$URL" "$PROJECT-test" 2>&1 || echo "ERROR: Clone failed"

# Cleanup
rm -rf "$PROJECT-test"
```

--------------------------------

### read_projects()

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/project-management.md

Parses the .projects.gws file to populate project data structures and update the internal cache.

```APIDOC
## read_projects()

### Description
Parses the .projects.gws file and populates project data structures. It updates the global 'projects' associative array and 'projects_indexes' array.

### Parameters
None (reads global PROJECTS_FILE constant)

### Returns
- 0: Always succeeds

### Example
```bash
# Manually trigger project re-parsing
read_projects
echo "Found ${#projects[@]} projects"
for path in "${projects_indexes[@]}"; do
    echo "Project: $path"
done
```
```

--------------------------------

### Define Projects Indexes Array

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/types.md

Defines the indexed array containing sorted project paths.

```bash
declare -a projects_indexes=(
    "contrib/gws"
    "personal/app"
    "work/tools/q"
)
```

--------------------------------

### Define Projects Associative Array

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/types.md

Defines the projects associative array mapping project paths to remote configuration strings.

```bash
declare -A projects=(
    [work/project-a]="origin|https://github.com/company/project-a.git, "
    [work/project-b]="origin|git@github.com:company/project-b.git, upstream|https://github.com/upstream/b.git, "
)
```

--------------------------------

### Check Workspace Consistency

Source: https://github.com/streakycobra/gws/blob/master/README.md

Scans the workspace to identify known, unknown, ignored, and missing repositories.

```bash
$ gws check
```

--------------------------------

### Update Workspace Repositories

Source: https://github.com/streakycobra/gws/blob/master/README.md

Clones missing repositories defined in the project list.

```bash
$ gws update
```

--------------------------------

### Ignore workspace files in .gitignore

Source: https://github.com/streakycobra/gws/blob/master/README.md

Recommended .gitignore configuration to track only the workspace definition files while ignoring the contents of the managed repositories.

```text
# Ignore everything, so all repositories in our case
*

# But not these files
!.projects.gws
!.gitignore
```

--------------------------------

### Generate Custom Status Reports

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/usage-patterns.md

Iterate through projects to identify missing directories and dirty Git states.

```bash
#!/bin/bash
# workspace_report.sh

source .cache.gws 2>/dev/null

declare -i total=0 clean=0 dirty=0 missing=0

echo "Workspace Report"
echo "================"
echo ""

for project in "${projects_indexes[@]}"; do
    ((total++))
    
    if [[ ! -d "$project" ]]; then
        ((missing++))
        echo "[$project] MISSING"
        continue
    fi
    
    # Quick dirty check
    if (cd "$project" && git diff --quiet 2>/dev/null && \
        git diff --cached --quiet 2>/dev/null); then
        ((clean++))
        echo "[$project] ✓ CLEAN"
    else
        ((dirty++))
        echo "[$project] ✗ DIRTY"
    fi
done

echo ""
echo "Summary"
echo "-------"
echo "Total projects:    $total"
echo "Clean:             $clean"
echo "Dirty:             $dirty"
echo "Missing:           $missing"
echo "Sync rate:         $((100 * (total - missing) / total))%"
```

--------------------------------

### Fetch and update repository with git_fetch_update

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/git-operations.md

Executes a fetch and rebase operation in a subshell. Use this to synchronize a repository with its upstream.

```bash
git_fetch_update <directory>
```

```bash
git_fetch_update "path/to/repo"
```

--------------------------------

### gws update

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/commands.md

Clones all missing repositories from the projects list into the workspace.

```APIDOC
## gws update

### Description
Clones all missing repositories from the projects list. Skips repositories that already exist in the workspace.

### Usage
`gws update`

### Parameters
- None

### Returns
- 0: Success

### Example
```bash
# Clone all missing repositories in current workspace
gws update

# Clone missing repos in specific subdirectory only
gws update work/
```
```

--------------------------------

### Check for workspace root with is_project_root

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/project-management.md

Verifies if the current directory is a workspace root by checking for the existence of .projects.gws.

```bash
is_project_root()
```

```bash
cd ~/dev
if is_project_root; then
    echo "This is a workspace"
else
    echo "Not a workspace"
fi
```

--------------------------------

### Clone a Git repository

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/git-operations.md

Executes a git clone command into a specified directory. Fails if the target directory already exists.

```bash
git_clone <url> <directory>
```

```bash
if git_clone "https://github.com/user/repo.git" "path/to/repo"; then
    echo "Cloned successfully"
else
    echo "Clone failed (error details printed above)"
fi
```

--------------------------------

### Process Ignored Patterns

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/types.md

Demonstrates the lifecycle of ignored patterns from raw input to filtering results.

```bash
# Input from .ignore.gws
^work/
test

# After read_ignored() processing
declared -a ignored_patterns=(
    "^work/"      # Match projects starting with "work/"
    "test"        # Match projects containing "test"
)

# After remove_matching()
projects_indexes=( "contrib/gws" "personal/app" )
# "work/tools/q" removed (matches ^work/)
```

--------------------------------

### Check project existence with exists_project

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/project-management.md

Verifies if a project path is registered in the projects_indexes array using case-sensitive matching.

```bash
exists_project <project_path>
```

```bash
if exists_project "work/tools/q"; then
    echo "Project is registered"
else
    echo "Project not found"
fi
```

--------------------------------

### Daily Status Check

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/usage-patterns.md

Monitors repository states and fetches updates.

```bash
# View status of all projects
gws

# Or equivalently:
gws status

# Show only projects with changes
gws --only-changes

# Fetch latest updates first
gws fetch

# After fetching, check for projects behind origin
gws --only-changes fetch
```

--------------------------------

### is_project_root()

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/project-management.md

Tests if the current directory is a workspace root by checking for the existence of a .projects.gws file.

```APIDOC
## is_project_root()

### Description
Tests if the current directory is a workspace root. It checks for the existence of a .projects.gws file in the current directory.

### Parameters
None (operates on current directory)

### Returns
- 0: Current directory contains .projects.gws file
- 1: Current directory is not a workspace root

### Example
```bash
cd ~/dev
if is_project_root; then
    echo "This is a workspace"
else
    echo "Not a workspace"
fi
```
```

--------------------------------

### Display Repository Status

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/errors.md

Shows the output format when checking repository status, including missing repository warnings.

```bash
$ gws status
work/project1
  Missing repository

contrib/gws
  * main : Clean
```

--------------------------------

### Update repositories with gws update

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/commands.md

Clones missing repositories in the workspace. Can be scoped to a specific subdirectory.

```bash
cmd_update()
```

```bash
# Clone all missing repositories in current workspace
gws update

# Clone missing repos in specific subdirectory only (via --only-changes)
gws update work/
```

--------------------------------

### Workspace consistency output format

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/commands.md

The standard output structure generated by the check command.

```text
Known:
  <project_path>
  ...

Unknown:
  <path>
  ...

Ignored:
  <project_path>
  ...

Missing:
  <project_path>
  ...
```

--------------------------------

### git_fetch()

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/git-operations.md

Fetches updates from the origin remote for a specified repository.

```APIDOC
## git_fetch()

### Description
Fetch updates from the origin remote.

### Parameters
- **directory** (string) - Required - Path to repository to fetch in

### Returns
- **0** - Fetch successful or no remote configured
- **1** - Fetch failed
```

--------------------------------

### Fetch Remote Modifications

Source: https://github.com/streakycobra/gws/blob/master/README.md

Fetches updates from origin for all managed repositories.

```bash
$ gws fetch
```

--------------------------------

### Ignore File Syntax

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/OVERVIEW.md

Defines the structure for the .ignore.gws file using POSIX extended regex patterns.

```text
<regex_pattern_1>
<regex_pattern_2>
...
```

--------------------------------

### Filter Projects by Directory

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/project-management.md

Filters a list of projects to include only those within a specified directory path.

```bash
keep_prefixed_projects <directory>
```

```bash
# Get all projects under work/ directory
projects=$(keep_prefixed_projects "work")
echo "Work projects: $projects"

# Limit command to specific subdirectory
gws status work/
# Internally calls: projects=$(keep_prefixed_projects "work") 
# Then operates only on matching projects
```

--------------------------------

### Execute Parallel Project Operations

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/usage-patterns.md

Process multiple projects concurrently by leveraging background subshells.

```bash
#!/bin/bash
# parallel_clone.sh

source .cache.gws 2>/dev/null || gws status > /dev/null

for project in "${projects_indexes[@]}"; do
    (
        echo "Processing $project in background"
        gws clone "$project" &>/dev/null
        echo "Cloned $project"
    ) &
done

wait
echo "All projects cloned"
```

--------------------------------

### git_clone()

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/git-operations.md

Clones a Git repository to a specified directory.

```APIDOC
## git_clone()

### Description
Clone a Git repository to a specified directory.

### Parameters
- **url** (string) - Required - Repository URL (any git-compatible format: HTTPS, SSH, local path)
- **directory** (string) - Required - Target directory path where repository will be cloned

### Returns
- **0** - Clone successful
- **1** - Clone failed
```

--------------------------------

### Fast-Forward Pull Repositories

Source: https://github.com/streakycobra/gws/blob/master/README.md

Pulls modifications from origin using fast-forward merges.

```bash
$ gws ff    # Mnemonic: ff=fast-forward
```

--------------------------------

### Customizable Color Theme Definition

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/configuration.md

Define color variables in theme files to customize output. Ensure C_OFF is defined to reset terminal colors.

```bash
# ~/.theme.gws or ~/.config/gws/theme

# Status indicators
C_CLEAN="\e[32m"           # Green = clean repositories
C_NOT_SYNC="\e[31m"         # Red = not synced, dirty
C_NO_REMOTE="\e[33m"        # Yellow = no remote configured

# Labels and headers
C_REPO="\e[34m"            # Blue = repository names
C_BRANCH="\e[35m"          # Magenta = branch names
C_LOGS="\e[36m"            # Cyan = additional info

# Errors and UI
C_ERROR="\e[31m"           # Red = errors
C_VERSION="\e[31m"         # Red = version display
C_HELP_PROGNAME="\e[31m"   # Red = program name in help
C_HELP_DIR="\e[32m"        # Green = directory in help

# Reset
C_OFF="\e[0m"              # Always define to reset colors
```

--------------------------------

### Create Ignore List

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/usage-patterns.md

Excludes specific projects from gws operations using regex patterns in .ignore.gws.

```bash
cat > .ignore.gws << 'EOF'
# Exclude work projects (work only on office computer)
^work/

# Exclude large/archived projects
^archived/
.*-old$

# Exclude temporary clones
.*-test$
EOF
```

--------------------------------

### Fix Out-of-Sync Projects

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/usage-patterns.md

Resyncs a local project by stashing current changes, fetching from origin, and performing a hard reset to the main or master branch.

```bash
#!/bin/bash
# resync_project.sh

PROJECT=$1

if [[ ! -d "$PROJECT" ]]; then
    echo "Project not found: $PROJECT"
    exit 1
fi

cd "$PROJECT"

echo "Resyncing: $PROJECT"
echo ""

# Save local changes
echo "1. Saving any local changes..."
STASH_ID=$(git stash push -m "auto-backup before resync" 2>&1 | grep -o 'Saved' || echo "none")

# Fetch latest
echo "2. Fetching from origin..."
git fetch origin || exit 1

# Reset to origin
echo "3. Resetting to origin/main..."
git reset --hard origin/main || git reset --hard origin/master || echo "ERROR: Could not reset"

# Show result
echo ""
echo "Status after resync:"
git status
```

--------------------------------

### Fetch updates from origin

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/git-operations.md

Performs a git fetch in the specified directory. Suppresses standard output and returns a non-zero exit code on failure.

```bash
git_fetch <directory>
```

```bash
if git_fetch "work/project"; then
    echo "Fetch completed"
else
    echo "Fetch failed"
fi
```

--------------------------------

### Clone Specific Repository

Source: https://github.com/streakycobra/gws/blob/master/README.md

Clones a single missing repository from the project list.

```bash
$ gws clone work/theSoftware
```

--------------------------------

### gws check

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/commands.md

Validates workspace consistency by categorizing repositories into known, unknown, ignored, and missing projects.

```APIDOC
## gws check

### Description
Validates workspace consistency by categorizing all repositories found. It performs scans for known projects, unknown repositories, ignored projects, and missing projects.

### Usage
`gws check [path]`

### Parameters
- **path** (string) - Optional - The specific subdirectory to check. If omitted, the entire workspace is scanned.

### Returns
- `0`: All checks completed
- Non-zero: Error accessing workspace

### Output Format
```
Known:
  <project_path>

Unknown:
  <path>

Ignored:
  <project_path>

Missing:
  <project_path>
```

### Example
```bash
# Check workspace consistency
gws check

# Check specific subdirectory only
gws check work/
```
```

--------------------------------

### Internal Cache File Structure

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/configuration.md

The .cache.gws file stores project metadata and file hashes as Bash declarations to avoid redundant parsing.

```bash
declare -- CACHED_PROJECTS_HASH='a1b2c3d4e5f6 .projects.gws'
declare -- CACHED_IGNORE_HASH='f6e5d4c3b2a1 .ignore.gws'
declare -A projects=([path1]="...config..." [path2]="...config...")
declare -a projects_indexes=([0]="path1" [1]="path2")
declare -a ignored_patterns=([0]="regex1" [1]="regex2")
```

--------------------------------

### Check repository status with gws status

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/commands.md

Displays the status of repositories, including sync state and local changes. Supports optional fetch or fast-forward operations.

```bash
cmd_status [<operation>]
```

```text
<project_name>
  * <branch_name> : [<status>] [<sync_status>] [<remote_info>]
```

```bash
# Show status of all repositories
gws status

# Fetch from all origins first, then show status
gws fetch

# Fast-forward all repos, then show status
gws ff

# Show only repositories with changes
gws --only-changes status
gws status --only-changes
```

--------------------------------

### Inspect and Invalidate Cache

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/errors.md

View the contents of the .cache.gws file or remove it to force a re-parse of configuration files.

```bash
cat .cache.gws
```

```bash
rm .cache.gws
# Forces immediate re-parse of .projects.gws and .ignore.gws
```

--------------------------------

### List Local Branches

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/git-operations.md

Retrieves all local branch names and stores them in the global 'branches' array.

```bash
git_branches <directory>
```

```bash
git_branches "work/project"
echo "Branches found: ${branches[@]}"
for branch in "${branches[@]}"; do
    echo "  - $branch"
done
```

--------------------------------

### Check Workspace Status

Source: https://github.com/streakycobra/gws/blob/master/README.md

Displays uncommitted changes, untracked files, and unsynced branches for all repositories.

```bash
$ gws status
```

```bash
$ gws
```

--------------------------------

### Check branch synchronization with origin

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/git-operations.md

Compares the local branch commit hash with the origin branch.

```bash
git_check_branch_origin <directory>
```

```bash
git_check_branch_origin "work/project"
case $? in
    0) echo "Branch is in sync with origin" ;;
    1) echo "Branch is ahead or behind origin" ;;
    2) echo "No remote branch configured" ;;
esac
```

--------------------------------

### List repository remotes with git_remotes

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/git-operations.md

Retrieves a newline-separated list of all remote names configured in the target repository.

```bash
git_remotes <directory>
```

```bash
remotes=$(git_remotes "work/project")
echo "Available remotes: $remotes"

for remote in $(git_remotes "path/repo"); do
    echo "Remote: $remote"
done
```

--------------------------------

### Configure gws alias for Mac OS X

Source: https://github.com/streakycobra/gws/blob/master/README.md

Workaround for GNU sed and cut dependencies on Mac OS X by aliasing gws with the path to coreutils and gnu-sed.

```bash
alias gws="PATH=/usr/local/opt/coreutils/libexec/gnubin:usr/local/opt/gnu-sed/libexec/gnubin:$PATH gws"
```

--------------------------------

### Filtering Operations by Directory

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/usage-patterns.md

Limits gws commands to specific project subdirectories or paths.

```bash
# Check status of work projects only
gws status work/

# Fast-forward only personal projects
gws ff personal/

# Show changes in contrib projects
gws --only-changes fetch contrib/

# Clone specific projects under tools
gws clone work/tools/utility work/tools/helper
```

--------------------------------

### Define Branches Array

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/types.md

Defines the global array used to store branch names.

```bash
declare -a branches=(
    "main"
    "develop"
    "feature/new-ui"
)
```

--------------------------------

### Define GWS Cache File Format

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/types.md

The cache file uses Bash variable declarations to store project state and configuration. It is intended to be sourced directly into a shell environment.

```bash
declare -- CACHED_PROJECTS_HASH='a1b2c3d4e5f6  .projects.gws'
declare -- CACHED_IGNORE_HASH='f6e5d4c3b2a1  .ignore.gws'
declare -A projects=([work/a]="origin|https://github.com/company/a.git, " [work/b]="origin|git@github.com:company/b.git, upstream|https://github.com/upstream/b.git, ")
declare -a projects_indexes=([0]="work/a" [1]="work/b")
declare -a ignored_patterns=([0]="^archived/" [1]=".*-tmp$")
```

--------------------------------

### Execute cmd_check function

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/commands.md

The internal function call for workspace consistency validation.

```bash
cmd_check()
```

--------------------------------

### Selective Ignore for Environments

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/usage-patterns.md

Manages environment-specific ignore lists by keeping local changes to .ignore.gws uncommitted.

```bash
# At work (include everything)
^archived/
```

```bash
# At home (exclude work)
^work/
```

```bash
# 1. Clone workspace repo
git clone git@github.com:user/workspace.git ~/dev

# 2. Update .ignore.gws for environment
# Edit locally (changes not committed)

# 3. Apply and use
gws update
gws status
```

--------------------------------

### Perform fast-forward merge with git_fast_forward

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/git-operations.md

Attempts a fast-forward merge from origin. Fails if local commits prevent a clean fast-forward.

```bash
git_fast_forward <directory>
```

```bash
if git_fast_forward "contrib/gws"; then
    echo "Fast-forwarded successfully"
else
    echo "Fast-forward not possible (local commits ahead?)"
fi
```

--------------------------------

### git_remotes

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/git-operations.md

Lists all remote names in a repository.

```APIDOC
## git_remotes

### Description
List all remote names in a repository.

### Usage
`git_remotes <directory>`

### Parameters
- **directory** (string) - Required - Path to repository

### Returns
- **0**: Always succeeds (even if no remotes)

### Example
```bash
remotes=$(git_remotes "work/project")
echo "Available remotes: $remotes"

for remote in $(git_remotes "path/repo"); do
    echo "Remote: $remote"
done
```
```

--------------------------------

### Check for untracked files

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/git-operations.md

Verifies if a repository contains any untracked files.

```bash
git_check_untracked <directory>
```

```bash
if ! git_check_untracked "work/project"; then
    echo "Repository contains untracked files"
fi
```

--------------------------------

### git_fast_forward

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/git-operations.md

Performs a fast-forward merge with the origin branch if possible.

```APIDOC
## git_fast_forward

### Description
Performs a fast-forward merge with the origin branch. Only succeeds if no new local commits are present.

### Parameters
- **directory** (string) - Required - Path to repository to fast-forward

### Returns
- **0** - Fast-forward successful
- **1** - Fast-forward failed or not possible

### Example
```bash
if git_fast_forward "contrib/gws"; then
    echo "Fast-forwarded successfully"
else
    echo "Fast-forward not possible"
fi
```
```

--------------------------------

### Define Ignored Projects in .ignore.gws

Source: https://github.com/streakycobra/gws/blob/master/README.md

Regular expression format for excluding specific project paths from GWS operations.

```text
^work/
```

--------------------------------

### Check Remote Existence

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/git-operations.md

Verifies if a specific remote exists in the target repository using case-sensitive matching.

```bash
git_remote_exists <directory> <remote_name>
```

```bash
if git_remote_exists "work/project" "upstream"; then
    echo "Upstream remote is configured"
else
    echo "No upstream remote found"
fi
```

--------------------------------

### gws status

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/commands.md

Displays the status of all repositories in the workspace, including sync status and local changes.

```APIDOC
## gws status

### Description
Displays comprehensive status for each repository, checking for unstaged modifications, staged changes, untracked files, and branch synchronization with origin.

### Usage
`gws status [<operation>]`

### Parameters
- **operation** (integer) - Optional - Operation mode: 0 (status only), 1 (fetch first), 2 (fast-forward first)

### Returns
- 0: All repositories clean
- 1: At least one repository has changes

### Example
```bash
# Show status of all repositories
gws status

# Show only repositories with changes
gws status --only-changes
```
```

--------------------------------

### Enable and Disable Debug Mode

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/errors.md

Use sed to toggle the set -x bash debug flag within the gws script to trace command execution.

```bash
# Enable debug mode
sed -i 's/^# set -x/set -x/' src/gws

# Run command with debug output
gws status

# Disable debug mode
sed -i 's/^set -x/# set -x/' src/gws
```

--------------------------------

### Retrieve remote URL with git_remote_url

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/git-operations.md

Captures the URL of a specific remote from a repository directory into a variable.

```bash
git_remote_url <directory> <remote_name>
```

```bash
origin_url=$(git_remote_url "work/project" "origin")
echo "Origin is at: $origin_url"
```

--------------------------------

### git_branches()

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/git-operations.md

Retrieves all local branch names in a repository and stores them in a global array.

```APIDOC
## git_branches(directory)

### Description
Gets all local branch names in a repository. The results are stored in a global `branches` array.

### Parameters
- **directory** (string) - Required - Path to repository

### Returns
- **0** - Branches retrieved successfully

### Side Effects
- Populates global `branches` array with branch names
```

--------------------------------

### git_fetch_update

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/git-operations.md

Fetches updates and performs an automatic fast-forward merge on the specified repository.

```APIDOC
## git_fetch_update

### Description
Fetches updates and performs automatic fast-forward merges for a given repository directory.

### Parameters
- **directory** (string) - Required - Path to repository to update

### Returns
- **0** - Fetch and update successful
- **1** - Operation failed

### Example
```bash
git_fetch_update "path/to/repo"
```
```

--------------------------------

### Check for staged changes

Source: https://github.com/streakycobra/gws/blob/master/_autodocs/api-reference/git-operations.md

Verifies if a repository has staged but uncommitted changes.

```bash
git_check_cached_uncommitted <directory>
```

```bash
if ! git_check_cached_uncommitted "work/project"; then
    echo "Repository has staged changes awaiting commit"
fi
```
Tokens:
Raw