Add descriptive comments to all scripts

Each file now has a brief comment explaining what the tool is and
what the script does, aimed at someone with general Linux knowledge.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Ole-Morten Duesund 2026-03-06 12:05:05 +01:00
commit 0791d74b0d
13 changed files with 16 additions and 0 deletions

View file

@ -1,2 +1,3 @@
# shellcheck shell=bash # shellcheck shell=bash
# Add Bun (a fast JavaScript runtime and package manager) to PATH
path_append "$HOME/.bun/bin" path_append "$HOME/.bun/bin"

View file

@ -1,3 +1,4 @@
# shellcheck shell=bash # shellcheck shell=bash
# Set up Go workspace and add compiled Go binaries to PATH
export GOPATH="$HOME/go" export GOPATH="$HOME/go"
path_append "$GOPATH/bin" path_append "$GOPATH/bin"

View file

@ -1,3 +1,4 @@
# shellcheck shell=bash # shellcheck shell=bash
# Set up Rust/Cargo and add installed Rust binaries to PATH
export CARGO_HOME="$HOME/.cargo" export CARGO_HOME="$HOME/.cargo"
path_append "$CARGO_HOME/bin" path_append "$CARGO_HOME/bin"

View file

@ -1,4 +1,7 @@
# shellcheck shell=bash # shellcheck shell=bash
# Configure C/C++ build tools:
# - Use Ninja instead of Make for CMake builds (faster parallel builds)
# - Use ccache to cache compilations and speed up rebuilds
if command -v ninja &>/dev/null; then if command -v ninja &>/dev/null; then
export NINJA_STATUS="[%e sec | %p (%u remaining) | %o / sec] " export NINJA_STATUS="[%e sec | %p (%u remaining) | %o / sec] "
export CMAKE_GENERATOR=Ninja export CMAKE_GENERATOR=Ninja

View file

@ -1,3 +1,4 @@
# shellcheck shell=bash # shellcheck shell=bash
# shellcheck disable=SC1090 # shellcheck disable=SC1090
# Tab completion for asdf, a tool that manages multiple language runtime versions
command -v asdf &>/dev/null && . <(asdf completion bash) command -v asdf &>/dev/null && . <(asdf completion bash)

View file

@ -1,3 +1,4 @@
# shellcheck shell=bash # shellcheck shell=bash
# shellcheck disable=SC1090 # shellcheck disable=SC1090
# Tab completion for fj, the Forgejo CLI (like GitHub CLI but for Forgejo)
command -v fj &>/dev/null && . <(fj completion bash) command -v fj &>/dev/null && . <(fj completion bash)

View file

@ -1,3 +1,4 @@
# shellcheck shell=bash # shellcheck shell=bash
# shellcheck disable=SC1090 # shellcheck disable=SC1090
# Tab completion for Tailscale, a mesh VPN for connecting devices
command -v tailscale &>/dev/null && . <(tailscale completion bash) command -v tailscale &>/dev/null && . <(tailscale completion bash)

View file

@ -1,4 +1,6 @@
# shellcheck shell=bash # shellcheck shell=bash
# Set up Android SDK and Java paths for Android development
# Adds adb, fastboot, and SDK command-line tools to PATH
if [[ -d "$HOME/android-sdk" ]]; then if [[ -d "$HOME/android-sdk" ]]; then
export ANDROID_HOME="$HOME/android-sdk" export ANDROID_HOME="$HOME/android-sdk"
path_append "$ANDROID_HOME/cmdline-tools/latest/bin" path_append "$ANDROID_HOME/cmdline-tools/latest/bin"

View file

@ -1,4 +1,5 @@
# shellcheck shell=bash # shellcheck shell=bash
# Forgejo API token used by Claude Code to read/write issues and PRs
# Copy to 99-claude and fill in your token, then: chmod 700 99-claude # Copy to 99-claude and fill in your token, then: chmod 700 99-claude
require_private "${BASH_SOURCE[0]}" require_private "${BASH_SOURCE[0]}"
export FORGEJO_ISSUE_TOKEN_FOR_CLAUDE=your-token-here export FORGEJO_ISSUE_TOKEN_FOR_CLAUDE=your-token-here

View file

@ -1,4 +1,5 @@
# shellcheck shell=bash # shellcheck shell=bash
# API key for Google Gemini (generative AI)
# Copy to 99-gemini and fill in your key, then: chmod 700 99-gemini # Copy to 99-gemini and fill in your key, then: chmod 700 99-gemini
require_private "${BASH_SOURCE[0]}" require_private "${BASH_SOURCE[0]}"
export GEMINI_API_KEY=your-key-here export GEMINI_API_KEY=your-key-here

View file

@ -1,4 +1,5 @@
# shellcheck shell=bash # shellcheck shell=bash
# API key for Google Cloud services
# Copy to 99-google and fill in your key, then: chmod 700 99-google # Copy to 99-google and fill in your key, then: chmod 700 99-google
require_private "${BASH_SOURCE[0]}" require_private "${BASH_SOURCE[0]}"
export GOOGLE_API_KEY=your-key-here export GOOGLE_API_KEY=your-key-here

View file

@ -1,4 +1,5 @@
# shellcheck shell=bash # shellcheck shell=bash
# Access token for Hugging Face (ML model hub and inference API)
# Copy to 99-huggingface and fill in your token, then: chmod 700 99-huggingface # Copy to 99-huggingface and fill in your token, then: chmod 700 99-huggingface
require_private "${BASH_SOURCE[0]}" require_private "${BASH_SOURCE[0]}"
export HF_TOKEN=your-token-here export HF_TOKEN=your-token-here

View file

@ -1,4 +1,5 @@
# shellcheck shell=bash # shellcheck shell=bash
# API token for Replicate (cloud ML model hosting)
# Copy to 99-replicate and fill in your token, then: chmod 700 99-replicate # Copy to 99-replicate and fill in your token, then: chmod 700 99-replicate
require_private "${BASH_SOURCE[0]}" require_private "${BASH_SOURCE[0]}"
export REPLICATE_API_TOKEN=your-token-here export REPLICATE_API_TOKEN=your-token-here