53 lines
5 KiB
Markdown
Executable file
53 lines
5 KiB
Markdown
Executable file
---
|
|
layout: default
|
|
title: .local-bin Documentation
|
|
nav_order: 1
|
|
---
|
|
|
|
# .local-bin Documentation
|
|
|
|
Welcome to the documentation for the `.local-bin` repository. This collection is designed to enhance and customize your development environment across **macOS** and **Linux** systems.
|
|
|
|
## Platform Compatibility
|
|
|
|
Most scripts in this repository support both macOS and Linux:
|
|
- **macOS**: Uses Homebrew for package management where applicable
|
|
- **Linux**: Detects and uses native package managers (apt, yum, dnf, pacman)
|
|
|
|
## Binary Files
|
|
|
|
- [aactivator.py](aactivator/Usage.md): A powerful script designed to automate the sourcing of environments in an interactive shell. Activate it effortlessly by evaluating `$(aactivator init)` in your shell.
|
|
- [sessionizer](sessionizer/Usage.md): This script simplifies the management of tmux sessions by providing an interactive interface to create or switch between sessions. If a session doesn't exist for a selected directory, it creates a new tmux session with the selected directory as the working directory.
|
|
- [windonizer](windownizer/Usage.md): This script is designed to streamline the process of sending commands to a specific tmux window. It takes a branch name (or any identifier) as an argument, creates a new window if it doesn't exist in the current tmux session, and sends the provided command to that window.
|
|
- [update_brew_lists](update_brew_lists/Usage.md): This script automates the process of updating Homebrew and associated package lists. It can be used to keep track of installed packages and update them as needed.
|
|
- [setup_dev_env](setup_dev_env/Usage.md): This script automates the setup of a development environment by installing essential tools, configuring common settings, and providing options for customization. Supports macOS (Homebrew) and Linux (apt-get, yum).
|
|
- [docker_check](docker_check/Usage.md): This script automates the process of ensuring Docker is installed and running before executing Docker-related commands. Supports macOS (Homebrew) and Linux (apt, yum, dnf, pacman).
|
|
- [add_yaml_header](add_yaml_header/Usage.md): This script ensures that YAML files within a specified directory contain the necessary `---` header. If a YAML file does not have the `---` header, the script adds it.
|
|
- [wzp](wzp/Usage.md): This script automates the process of starting a new Wezterm project. It allows you to select a project from a predefined list or specify a project name as an argument.
|
|
- [manwhere](manwhere/Usage.md): A compiled binary tool for finding different types of man pages. Search across man page sections with filtering by section number.
|
|
- [volumizer](volumizer/Usage.md): This script manages volume levels on macOS and Linux systems. It limits the volume to a specified maximum when headphones are connected, protecting users' hearing. It integrates notifications to alert users of volume changes and headphone status seamlessly.
|
|
- [fzf_theme](fzf_theme/Usage.md): This script configures the `fzf` color theme based on the system's appearance mode (Light or Dark) for both macOS and Linux systems. Automatically detects GNOME, KDE, and other desktop environments on Linux.
|
|
- [bootstrap_setup](bootstrap_setup/Usage.md): Bootstraps a new development machine by installing essential tools (git, stow, curl), cloning dotfiles repository, and setting up dev scripts. Supports dry-run mode with `--dry-run` flag.
|
|
- [buildnote](buildnote/Usage.md): Converts markdown notes to PDF using pandoc with xelatex engine. Uses DejaVu fonts and applies syntax highlighting for code blocks.
|
|
- [most_recent_note](most_recent_note/Usage.md): Opens the most recently created PDF note from Google Drive notes folder using zathura PDF viewer.
|
|
- [notetaker](notetaker/Usage.md): Creates and opens daily markdown notes with YAML frontmatter in Neovim. Automatically timestamps entries and organizes notes by date.
|
|
- [kaggle_manager](kaggle_manager/Usage.md): Manages Kaggle datasets and notebooks. Downloads datasets, fetches notebooks, and submits competition entries using Kaggle API credentials.
|
|
- [promodoro](promodoro/Usage.md): Pomodoro timer script for productivity tracking.
|
|
- [promodoro_menu](promodoro_menu/Usage.md): Interactive menu interface for the Pomodoro timer.
|
|
- [setup_crontab](setup_crontab/Usage.md): Sets up automated cron jobs for system maintenance and scheduled tasks.
|
|
- [add_ipykernel](add_ipykernel/Usage.md): Adds Python virtual environments as Jupyter ipykernel options.
|
|
- [get_app_id](get_app_id/Usage.md): Retrieves macOS application bundle identifiers.
|
|
- [setup_macos_dock](setup_macos_dock/Usage.md): Configures macOS Dock settings including auto-hide, icon size, and app placement.
|
|
|
|
Feel free to use these scripts to simplify tasks and enhance your development workflow.
|
|
|
|
## Getting Started
|
|
|
|
If you're new to .local-bin, follow these steps to get started:
|
|
|
|
1. Clone the repository: `git clone https://git.jfraeys.com/jfraeysd/.local-bin.git`
|
|
2. Navigate to the `.local-bin` directory: `cd .local-bin`
|
|
3. Explore the documentation sections to learn about each script and its usage.
|
|
|
|
Happy coding!
|
|
|