Getting Started
Running the Application
bash
python kebab_cli.py
The terminal will boot and display a welcome message:
text
Kebab-CLI v0.1.0 - Shell
Type 'help' for available commands and shortcuts
User Interface
Menu Bar
Located at the top of the window with the following menus:
File Menu
- Save: Saves current terminal output to
output.txtin the current working directory - Save As: Opens a dialog to specify a custom filename for saving
- Clear: Clears all terminal output from the display
Edit Menu
- Copy: (Placeholder for future implementation)
- Paste: (Placeholder for future implementation)
View Menu
- Zoom In: (Placeholder for future implementation)
- Zoom Out: (Placeholder for future implementation)
Window Menu
- Minimize: (Placeholder for future implementation)
- Maximize: (Placeholder for future implementation)
Settings Panel
Click the Settings button (located to the right of the menu bar) to open the settings panel.
Available Settings
- Font Size: Adjust text size (drag slider)
- Line Height: Adjust spacing between lines (drag slider)
- Color Options: Customize terminal colors (if available)
Close the settings panel by:
- Clicking the X button in the top-right corner
- Clicking outside the panel (if implemented)
Interaction
Keyboard Input
Type commands directly into the terminal. The cursor appears at the bottom of the screen on the input line.
- Enter: Execute command
- Backspace: Delete character
- Left/Right Arrow: Navigate cursor
- Up/Down Arrow: Command history (if implemented)
Mouse Operations
Text Selection
- Click and drag to select text
- The cursor changes to a text cursor when hovering over text
- Selected text is highlighted
Menu Interaction
- Click a menu label to open the dropdown
- Click a menu item to execute the action
- Click outside the menu to close it
Scrolling
- Mouse Wheel Up: Scroll up through output
- Mouse Wheel Down: Scroll down through output
- Scroll in Settings Panel: Scroll through settings options (if panel is open)
File Operations
Saving Output
Standard Save
- Click File → Save
- Output saves to
output.txtin your current working directory - Confirmation message appears in the terminal
Save As
- Click File → Save As
- A dialog appears asking for a filename
- Enter your desired filename
- File saves to the working directory
- Confirmation message appears in the terminal
Working Directory
The default working directory is storage/files/ relative to the application installation.
Files are saved with ANSI color codes removed (plain text only).
Window Management
Window Sizing
- Double-click the window to maximize/restore
- Drag edges to resize manually
- Application responds to window resize in real-time
DPI Awareness
- Windows: Automatic DPI awareness prevents blurriness
- Other systems: Standard Pygame rendering
Tips & Tricks
- Selecting Output: Use mouse to select and copy text from previous commands
- Customizing Display: Use Settings to find your preferred font size and line height
- Saving Work: Regularly save important output to preserve your work
- Command History: If available, use arrow keys to navigate previous commands
- Multiple Files: Use "Save As" to create multiple versions of your terminal session
Troubleshooting
Nothing Happens When I Click
- Ensure you're clicking on the correct element
- For menus, click the menu label first to open the dropdown
- For settings, click the Settings button to open the panel
Text Appears Blurry
- Try adjusting font size in Settings
- Check your display scaling settings
Can't Find Where Files Were Saved
- Default location:
storage/files/in the application directory - Use "Save As" to save to a specific location
Settings Panel Won't Close
- Click the X button in the top-right corner of the panel
- Try clicking outside the panel