Download and Installation

To use Mample in your browser, you first need to download the appropriate extension for your browser (Chrome, Mozilla, Opera, Edge) and our mobile app from the Google Play Store.

Pairing and Connection Management

You can instantly connect your device by scanning the QR Code in your browser extension with the Mample app on your mobile device, or by entering your Secret Key into the relevant field in the extension. You can view the connection in the "Connected Devices" section of your mobile app.

For your security, all extension connections are automatically disconnected after 23 hours. You can also manually disconnect instantly by clicking the "Disconnect" icon (broken chain) on your phone or from your extension.

Receiving Notifications by Selecting a Key

You can teach Mample which button to track by typing /mample on any website or clicking the Select Key button in the extension. When you do this, a key selection interface will appear on the screen. The button you select should be a static, non-animated element that appears when the process starts and disappears when it ends. For example, a 'Stop generating' or 'Cancel' button. Once trained, Mample will send you a notification when the selected button disappears. Your selected button is saved, and you won't need to select it again.

Once your key is set, you have two ways to get notified:

1. Using a Command: Simply type /mample at the end of your prompt. Mample will track that specific process and notify you once.

2. Using the Extension: For websites where you cannot type a prompt, or for a fully automated experience, you can check the Get Notifications from Selected Key option in the extension. This way, you will automatically receive a notification every time your trained button disappears.

You can manage and delete your trained sites using the ☰ menu in the extension.

IMPORTANT NOTE: We strongly recommend keeping the tab and window active while waiting for a process. Most modern websites pause their HTML rendering to save resources when placed in the background. Because the website does not update its interface while hidden, Mample cannot detect that the process has finished until you switch back to the tab.

Receiving Notifications from Downloads

By enabling the Get Notifications for Downloads option in the extension, you can receive a notification when files larger than your specified MB limit finish downloading.

CLI Setup and Connection

To receive notifications from the terminal, you first need to download our mobile app from the Google Play Store. Then, you need to install the Mample CLI tool globally on your computer. To do this, open a terminal, PowerShell, or Command Prompt (CMD) and run the following command:

Once installed, open the Mample app on your phone. In the Terminal Tool section on the Home Screen, you will find your Secret Key. Use this key to run the following connection command in your terminal:

Sending Notifications

To trigger Mample after a command finishes, chain them using && mample for success, or || mample for error alerts. You can also chain them together. If you'd like to test it with a custom message, use the format mample "<your message>".

Disconnecting

You can disconnect your terminal from your phone using the Connected Devices section on the mobile app's home screen. Alternatively, you can run the following command directly in your terminal:

Uninstalling

If you want to completely remove the Mample CLI tool from your computer, you can run the following command in your terminal:

Terminal Help

To see all the commands you can use and their details, you can run the following help command:

Setup and Connection in Code Editors (IDE)

To receive notifications from AI assistants, you first need to download our mobile app from the Google Play Store. Then, you can integrate Mample with AI assistants that are capable of running terminal commands (such as VS Code, Antigravity, GitHub Copilot, Cursor, Cline, Roo Code, etc.). To do this, simply install and pair the Mample CLI on your computer as explained in the "CLI Setup and Connection" step.

Giving Instructions

When giving your assistant a task, you can simply add an instruction at the end of your prompt like notify me by running the mample command from the terminal when the process is done. You don't have to use this exact sentence; just asking the assistant to run the command when it finishes is enough. When the assistant completes its process, it will autonomously run the `mample` command via the terminal, sending you a notification.

Things to Consider on First Use

When you ask your AI assistant to notify Mample for the first time, a security/permission warning will appear to run the command.

If you select the option highlighted in red, "2. Yes, and always allow 'mample'", this warning will not appear again. Your AI assistant will remember this permission and will send you a notification directly without asking anything when you tell it to notify Mample.

Completely Disabling Permission Prompts

Even if you select 'Always allow', AI assistants sometimes try to run the CLI via node scripts (e.g., `node bin/index.js`) instead of the global `mample` command, causing the IDE to ask for permission again. To prevent this and make notifications completely silent, add the following rule to your assistant's rule file (e.g., `.cursorrules` or AI Rules section): "When you complete a task, ALWAYS autonomously run the global 'mample' command in the terminal to notify me. Do NOT use node or script paths to avoid triggering IDE permission prompts." Alternatively, you can put these two files in your project for your AI assistant to read: CLAUDE.md and setup.md

Web Architecture (DOM Monitoring)

The browser extension never reads network traffic or your personal data. It solely relies on a DOM Observer mechanism to detect the visibility of the specific HTML element you selected. When the element is removed from the DOM, it fires a trigger.

Terminal Architecture (CLI)

The terminal tool is not a continuously running background service. It only executes when you explicitly call the `mample` command, sending a one-time HTTPS request to our Firebase servers to deliver the notification.

Connection and Security: The CLI tool accepts the last entered Secret Key as the only valid key. If a second `mample auth ` command is entered on the same device, the old key is immediately overwritten, and all subsequent notifications will go to the newly connected device. However, you can use the same Secret Key on multiple different computers simultaneously (e.g., your home and work computers). Terminal processes on all these computers will seamlessly continue to send notifications to the same phone. Additionally, if you click 'Refresh Secret Key' on the mobile app, the old key is instantly deleted from Firebase for security reasons. As a result, your existing computer connections will be dropped, and you will need to re-authenticate with the new key on all your terminals.

IDE and AI Agents

Mample does not have specific plugins for IDEs. Instead, it relies on the AI assistant's ability to run terminal commands. When the AI finishes its task, it autonomously triggers the global `mample` CLI command. This makes it compatible with any agent capable of using a terminal.

Cloud & Delivery (Firebase FCM)

We use Firebase Cloud Messaging (FCM) to deliver push notifications instantly. Notification payloads are not stored in any cloud database; Firebase acts purely as a relay to pass the message directly to your device.

Payment & Accounts (RevenueCat)

Mample has no user account system. Subscriptions are securely processed through the App Store and Google Play. We use RevenueCat to manage entitlements across devices via an anonymous, randomly generated 'Transfer Code', ensuring your credit card details are never stored by us.