Skip to content

Commit 58e3cce

Browse files
committed
update readme
1 parent 4c6c7d3 commit 58e3cce

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,20 +25,20 @@ Configure AI controls by running the appropriate script for your platform:
2525
2626
Download and run the appropriate script for your platform:
2727

28-
- [Windows PowerShell Script](https://download.phcode.dev/ai-control/setup_phoenix_ai_control_win.ps1)
28+
- [Windows Batch Script](https://download.phcode.dev/ai-control/setup_phoenix_ai_control_win.bat)
2929
- [macOS Script](https://download.phcode.dev/ai-control/setup_phoenix_ai_control_mac.sh)
3030
- [Linux Script](https://download.phcode.dev/ai-control/setup_phoenix_ai_control_linux.sh)
3131

3232
#### Windows Installation
3333

34-
1. Download the Windows PowerShell script:
35-
- `setup_phoenix_ai_control_win.ps1`
36-
2. Open PowerShell as Administrator:
37-
- Press Win+X and select "Windows PowerShell (Admin)"
34+
1. Download the Windows Batch script:
35+
- `setup_phoenix_ai_control_win.bat`
36+
2. Open Command Prompt as Administrator:
37+
- Press Win+X and select "Command Prompt (Admin)"
3838
- Navigate to the download location using `cd` command
3939
3. Execute with parameters, for example:
4040
```
41-
.\setup_phoenix_ai_control_win.ps1 --managedByEmail [email protected] --disableAI
41+
setup_phoenix_ai_control_win.bat --managedByEmail [email protected] --disableAI
4242
```
4343
Note: The `--managedByEmail` parameter is optional but recommended
4444

@@ -72,7 +72,7 @@ All installation scripts support the same command-line options:
7272
|--------|-------------|
7373
| `--help` | Display usage information and help text |
7474
| `--managedByEmail <email>` | Optional but recommended. Admin email who manages AI policy. Can be used in your Phoenix managed AI dashboard to selectively enable features and manage usage quotas |
75-
| `--allowedUsers <user1,user2,...>` | Comma-separated list of usernames allowed to use AI even when disabled for others |
75+
| `--allowedUsers "<user1,user2,...>"` | Comma-separated list of usernames allowed to use AI even when disabled for others. **IMPORTANT:** Always enclose the list in quotes to prevent parsing errors |
7676
| `--disableAI` | If present, AI will be disabled by default for all users except those specified in `allowedUsers` |
7777

7878
### Example Usage
@@ -81,15 +81,17 @@ All installation scripts support the same command-line options:
8181
# Enable AI with administrative contact
8282
sudo ./setup_phoenix_ai_control_linux.sh --managedByEmail [email protected]
8383

84-
# Enable AI for specific users only
85-
sudo ./setup_phoenix_ai_control_linux.sh --allowedUsers alice,bob --disableAI
84+
# Enable AI for specific users only (IMPORTANT: always use quotes for multiple users)
85+
sudo ./setup_phoenix_ai_control_linux.sh --allowedUsers "alice,bob" --disableAI
8686

8787
# Complete setup with all options
88-
sudo ./setup_phoenix_ai_control_linux.sh --managedByEmail [email protected] --allowedUsers alice,bob --disableAI
88+
sudo ./setup_phoenix_ai_control_linux.sh --managedByEmail [email protected] --allowedUsers "alice,bob" --disableAI
8989
```
9090

9191
> **Note:** Always replace `[email protected]` with an actual administrator email address. The scripts will detect and reject placeholder email addresses.
9292
93+
> **IMPORTANT:** When specifying multiple users with `--allowedUsers`, always enclose the comma-separated list in quotes (`"alice,bob"`) to prevent parsing errors on all platforms.
94+
9395
### Configuration File Locations
9496

9597
The scripts create configuration files in the following system-wide locations:

0 commit comments

Comments
 (0)