Skip to content

Commit 6f1a675

Browse files
improve documentation
1 parent 41834e4 commit 6f1a675

1 file changed

Lines changed: 45 additions & 69 deletions

File tree

README.md

Lines changed: 45 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,41 @@ OSA Scripts provides a modular collection of zsh aliases, functions, and plugins
1616
- **Version Manager Support**: Integrations for nvm, fnm, rbenv, pyenv, jenv, and direnv
1717
- **Developer Aliases**: Time-saving shortcuts for npm, yarn, git, and common development tasks
1818

19+
## Setup
20+
21+
These scripts work with the [OSA](https://github.com/VirtualizeLLC/osa) configuration system.
22+
23+
### Quick Start
24+
25+
1. **Use OSA**: Install and run `osa setup` to automatically configure your environment
26+
2. **Or Manual Setup**: Source `entry.zsh` in your shell profile and generate a `~/.osa-config` file
27+
28+
### Configuration
29+
30+
Scripts are loaded based on boolean flags in `~/.osa-config`. Key configuration values:
31+
32+
```bash
33+
# Core components
34+
OSA_CONFIG_COMPONENTS_GIT=true # Git aliases
35+
OSA_CONFIG_COMPONENTS_NODE=true # Node.js tools
36+
OSA_CONFIG_COMPONENTS_HOMEBREW=true # Homebrew utilities
37+
38+
# Development tools
39+
OSA_CONFIG_RUNTIMES_NODE_ENABLED=true # Node runtime management
40+
OSA_CONFIG_SNIPPETS_OSASNIPPETS_REACT_NATIVE=true # React Native tools
41+
OSA_CONFIG_SNIPPETS_OSASNIPPETS_ANDROID=true # Android development
42+
```
43+
44+
See the [OSA repository](https://github.com/VirtualizeLLC/osa) for complete configuration options.
45+
1946
## Productivity Scripts
2047

2148
Key scripts designed to boost developer productivity:
2249

2350
### File Management
2451

2552
**`rmAsync` - Asynchronous Bulk File Deletion**
53+
2654
- **Problem Solved**: Unblocks developers instantly when deleting massive directories (node_modules, build artifacts, etc)
2755
- **How It Works**: Moves files to a staging area and deletes them in the background, returning control immediately
2856
- **Usage**: `rmAsync node_modules` or `rmAsync src/**/*.tmp build/*`
@@ -32,109 +60,57 @@ Key scripts designed to boost developer productivity:
3260
### Xcode & iOS Development
3361

3462
**`xcwo` - Smart Xcode Workspace Opener**
63+
3564
- **Problem Solved**: Quick access to Xcode workspace without remembering directory structure
3665
- **How It Works**: Automatically finds and opens `.xcworkspace` in current or ios/ subdirectory
3766
- **Usage**: `xcwo`
3867
- **Benefits**: Saves time in React Native development workflows
3968

4069
**`purgeallbuilds` - Clear Xcode Cache**
70+
4171
- **Aliases**: Instantly clears all Xcode derived data to fix mysterious build issues
4272
- **Usage**: `purgeallbuilds`
4373

4474
### Browser Development
4575

4676
**`chrome-cors` & `chrome-cors-https`** - CORS-Disabled Chrome Instances
77+
4778
- **Problem Solved**: Launch Chrome without CORS restrictions for local development
4879
- **Usage**: `chrome-cors` or `chrome-cors-https`
4980
- **Perfect For**: API testing, frontend development, HTTPS localhost testing
5081

5182
### React Native Development
5283

5384
**`rn-fix`** - Complete React Native Reset
85+
5486
- **Clears**: Node modules, watchman, temp files, cache
5587
- **Usage**: `rn-fix`
5688
- **Saves Time**: 5-10 minutes of manual cleanup per fix
5789

5890
**`rnios` / `rnra`** - iOS/Android Launch Shortcuts
91+
5992
- **Usage**: `rnios` (iOS) or `rnra` (Android)
6093
- **Benefit**: Fewer keystrokes, faster iteration
6194

6295
### Package Manager Helpers
6396

6497
**`react-native` / `rn`** - Shorthand aliases
98+
6599
- **Auto-detects** lock files (yarn.lock, package-lock.json) for correct package manager
66100
- **Usage**: `rn run-ios`, `rn run-android`
67101

68-
## Setup
69-
70-
### Installation
71-
72-
These scripts are designed to work with the OSA configuration system. They will be automatically sourced when you set up your OSA profile.
102+
### CLI Tools
73103

74-
1. Clone or integrate this repository into your OSA setup
75-
2. Run the OSA installation wizard to configure your profile
76-
3. 3. Configuration will be saved to `~/.osa-config`
77-
4. Scripts matching your configuration will be automatically loaded
78-
79-
### Configuration
104+
**`osa copilot audit-auto-approve`** - Audit GitHub Copilot Auto-Approve Tasks
80105

81-
Scripts are loaded based on boolean flags set in `~/.osa-config`. This file is automatically generated by the OSA setup wizard and contains flags like:
82-
83-
```bash
84-
# Example ~/.osa-config
85-
OSA_SETUP_OH_MY_ZSH=true
86-
OSA_SETUP_HOMEBREW=true
87-
OSA_SETUP_COCOAPODS=false
88-
OSA_SETUP_ZSH_PLUGINS=true
89-
OSA_SETUP_GIT=false
90-
OSA_SETUP_SYMLINKS=true
91-
OSA_SETUP_ANDROID=true
92-
OSA_SETUP_MISE=true
93-
```
94-
95-
**Common Configuration Flags:**
96-
- `OSA_SETUP_OH_MY_ZSH` - Oh My Zsh and Powerlevel10k
97-
- `OSA_SETUP_HOMEBREW` - Homebrew package manager utilities
98-
- `OSA_SETUP_GIT` - Git aliases and shortcuts
99-
- `OSA_SETUP_ANDROID` - Android SDK, ADB, and emulator tools
100-
- `OSA_SETUP_COCOAPODS` - CocoaPods utilities for iOS development
101-
- `OSA_SETUP_MISE` - Mise universal version manager (Node, Python, Ruby, Java, etc.)
102-
- `OSA_SETUP_ZSH_PLUGINS` - Additional zsh plugins and themes
103-
104-
**Optional Flags (defaults to false):**
105-
- `OSA_SETUP_NODE` - Node.js tools (if not using mise)
106-
- `OSA_SETUP_PYTHON` - Python/pyenv (if not using mise)
107-
- `OSA_SETUP_RUBY` - Ruby/rbenv (if not using mise)
108-
- `OSA_SETUP_JAVA` - Java/jenv (if not using mise)
109-
- `OSA_SETUP_REACT_NATIVE` - React Native development tools
110-
- `OSA_SETUP_VSCODE` - VS Code integration
111-
- `OSA_SETUP_XCODE` - Xcode command utilities
112-
- `OSA_SETUP_MAC_TOOLS` - macOS-specific utilities
113-
114-
## Structure
115-
116-
```
117-
├── entry.zsh # Main entry point with profile guards
118-
├── aliases/ # Command aliases and shortcuts
119-
│ ├── git.zsh
120-
│ ├── node.zsh
121-
│ ├── npm.zsh
122-
│ ├── yarn.zsh
123-
│ └── osa.zsh
124-
└── plugins/ # Feature-specific plugins and utilities
125-
├── brew.zsh
126-
├── direnv.zsh
127-
├── java-version.zsh
128-
├── jenv.zsh
129-
├── pyenv.sh
130-
├── rbenv.zsh
131-
├── react-native.zsh
132-
├── vscode.zsh
133-
├── android/ # Android development tools
134-
├── mac/ # macOS-specific utilities
135-
├── node-managers/ # nvm, fnm configurations
136-
└── tar/ # Archive utilities
137-
```
106+
- **Problem Solved**: Ensures VSCode Copilot autoApproveTasks only contain safe Gradle patterns
107+
- **How It Works**: Scans VSCode settings for risky auto-approve patterns in Gradle build files
108+
- **Usage**: `osa copilot audit-auto-approve [--allow-prefix <prefixes>] [--fail-on-risk] [--json]`
109+
- **Options**:
110+
- `--allow-prefix`: Comma-separated allowed prefixes (default: "tachyon")
111+
- `--fail-on-risk`: Exit with error if risky patterns found
112+
- `--json`: Output results in JSON format
113+
- **Perfect For**: Security auditing, CI/CD pipelines, team policy enforcement
138114

139115
## Productivity Benefits
140116

@@ -150,4 +126,4 @@ This is part of the OSA project. For contributions, issues, or feature requests,
150126

151127
## License
152128

153-
See the main [OSA repository](https://github.com/VirtualizeLLC/osa) for license information.
129+
See the main [OSA repository](https://github.com/VirtualizeLLC/osa) for license information.

0 commit comments

Comments
 (0)