clickolas-cage

KO | EN

gitlite — search

#javascript #python #hacktoberfest #typescript #llm #android #machine-learning #rust #linux #docker #java #cli #kubernetes #awesome-list

(★ 122)

a chrome extension that performs web browsing actions autonomously to complete a given goal/task (using LLM as brain).

File Explorer

Download Latest Version (.zip)

- - logo-48.png
- - config.js
  - llm-utils.js
  - manifest.js
  - prompts.js
  - utils.js
- .editorconfig
- .env.template
- .gitignore
- .npmignore
- .prettierignore
- .prettierrc
- CHANGELOG.md
- devtools.html
- jsconfig.json
- LICENSE
- newtab.html
- options.html
- package-lock.json
- package.json
- popup.html
- README.md
- sidepanel.html
- vite.config.js
- yarn.lock
.babelrc
.DS_Store
.gitignore
icon-128.png
icon-34.png
icon2.png
logo.ico
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

discord: [https://discord.gg/cK9WeQ7jPq](https://discord.gg/cK9WeQ7jPq)

[quick demo](https://youtu.be/JKBv1uUnrSk)

[v0.0.2 install guide](https://www.youtube.com/watch?v=bL6tV_LojOk)

[gemini hackathon submission](https://www.youtube.com/watch?v=HVevc5XnKJU)

# clickolas-cage

> a chrome extension that performs web browsing actions autonomously to complete a given goal/task (using LLM as a brain).
)

## Run built
follow instructions on the latest release:
https://github.com/aj47/clickolas-cage/releases

## Run from source

1. Check if your `Node.js` version is >= **14**.
run these commands to run everything locally:
```shell
cd clickolas-cage
npm install
npm run dev
```

Enter an [OpenRouter](https://openrouter.ai/) API key in the popup settings.

This runs the chrome extension locally.

To link the running extension to chrome:
1. set your Chrome browser 'Developer mode' on
2. click 'Load unpacked', and select `clickolas-cage/build` folder

## Using Clickolas Cage

### Opening the Extension

There are two ways to open the Clickolas Cage extension:

1. Click on the extension icon in your Chrome toolbar.
2. Use the keyboard shortcut: 
   - Windows/Linux: `Ctrl+Shift+L`
   - Mac: `Command+Shift+L`

### How to Use

1. Once the extension popup opens, you'll see a text area where you can enter your goal or task.
2. You can type your goal directly or use the speech-to-text feature:
   - Click the "Start Listening" button to activate speech recognition.
   - Speak your goal clearly.
   - Click "Stop Listening" when you're done.
3. Click the "Submit" button or press Enter to start the automation process.
4. A side panel will appear on the webpage, showing the steps Clickolas Cage is taking to complete your task.
5. You can interact with the side panel to provide additional input or stop the execution if needed.

### API Keys [OpenRouter](https://openrouter.ai/) API key

To use Clickolas Cage, you'll need to provide [OpenRouter](https://openrouter.ai/) API key for the language models. The extension supports multiple providers:

---

### Sidepanel Controls

Once Clickolas Cage starts executing your task, a sidepanel will appear on the right side of the webpage. This panel provides the following controls and information:

1. **Minimize/Maximize**: Click the '▼' or '▲' button in the top-right corner to minimize or maximize the sidepanel.

2. **Drag and Move**: You can click and drag the top bar of the sidepanel to reposition it on the page.

3. **Message List**: The main area of the sidepanel displays messages, including:
   - Steps being executed
   - User inputs
   - System messages
   - Completion messages

4. **Stop Execution**: When Clickolas Cage is actively executing a task, a "Stop Execution" button will appear. Click this to halt the current operation.

5. **Input Area**: When not executing, you'll see an input field where you can:
   - Type additional instructions or queries
   - Use voice input for hands-free interaction

6. **Voice Input**: 
   - Click the "Voice" button or use the keyboard shortcut (Ctrl+Shift+K) to start/stop voice recognition.
   - When active, it will display "Stop" and the button will highlight.
   - Speak your instruction clearly, then click "Stop" or use the shortcut again to submit.

7. **Send Button**: Click "Send" or press Enter to submit your typed or voice-transcribed input.

The sidepanel allows you to monitor the progress of your task, provide additional input when needed, and control the execution of Clickolas Cage directly from the webpage.

---

clickolas-cage

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

clickolas-cage

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README