Skip to content

Commit 68d0ea2

Browse files
authored
Merge pull request #54 from MeshkatShB/docs/update-readme
Docs/update readme
2 parents 786d0ae + a2f6a2a commit 68d0ea2

File tree

2 files changed

+39
-0
lines changed

2 files changed

+39
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,7 @@ ENV/
130130
env.bak/
131131
venv.bak/
132132
test_env/
133+
myenv
133134

134135

135136
# Spyder project settings

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,44 @@ playwright install
6161
- Open the WebUI in a non-Chrome browser, such as Firefox or Edge. This is important because the persistent browser context will use the Chrome data when running the agent.
6262
- Check the "Use Own Browser" option within the Browser Settings.
6363

64+
### Options:
65+
66+
### `--theme`
67+
68+
- **Type**: `str`
69+
- **Default**: `Ocean`
70+
- **Description**: Specifies the theme for the user interface.
71+
- **Options**:
72+
The available themes are defined in the `theme_map` dictionary. Below are the options you can choose from:
73+
- **Default**: The standard theme with a balanced design.
74+
- **Soft**: A gentle, muted color scheme for a relaxed viewing experience.
75+
- **Monochrome**: A grayscale theme with minimal color for simplicity and focus.
76+
- **Glass**: A sleek, semi-transparent design for a modern appearance.
77+
- **Origin**: A classic, retro-inspired theme for a nostalgic feel.
78+
- **Citrus**: A vibrant, citrus-inspired palette with bright and fresh colors.
79+
- **Ocean** (default): A blue, ocean-inspired theme providing a calming effect.
80+
81+
**Example**:
82+
83+
```bash
84+
python webui.py --ip 127.0.0.1 --port 7788 --theme Glass
85+
```
86+
87+
### `--dark-mode`
88+
89+
- **Type**: `boolean`
90+
- **Default**: Disabled
91+
- **Description**: Enables dark mode for the user interface. This is a simple toggle; including the flag activates dark mode, while omitting it keeps the interface in light mode.
92+
- **Options**:
93+
- **Enabled (`--dark-mode`)**: Activates dark mode, switching the interface to a dark color scheme for better visibility in low-light environments.
94+
- **Disabled (default)**: Keeps the interface in the default light mode.
95+
96+
**Example**:
97+
98+
```bash
99+
python webui.py --ip 127.0.0.1 --port 7788 --dark-mode
100+
```
101+
64102
## (Optional) Configure Environment Variables
65103

66104
Copy `.env.example` to `.env` and set your environment variables, including API keys for the LLM. With

0 commit comments

Comments
 (0)