No project description provided
Project description
Overview
A Python SDK and CLI client for interacting with the agent and the APIs.
Getting Started
Installation
pip install multilogin
Examples
For full commands list, run
mlx --help
CLI and SDK Comparison
CLI Command | Description |
---|---|
mlx agent start |
Start the MLX agent. |
mlx agent stop |
Stops the agent |
mlx agent status |
View its status |
mlx agent logs |
Tail logs (~/mlx/logs/*.log) |
mlx core download -w |
Download core browser and wait for completion. |
mlx credentials |
Set or print current username and password. |
mlx ping |
Test launcher connectivity. Expect 'pong' as a response when API returns 200. |
mlx quick |
Launch a quick profile. |
mlx ready |
Block until the API is ready or timeout is reached. |
mlx sessions |
List all sessions. |
mlx token |
Set or print the current authentication token. |
mlx version |
Get the agent's version. |
mlx whoami |
Print the current user. |
SDK
The MLX SDK allows you to programmatically interact with the MLX services. Here's a quick example:
from mlx.api.launcher import LauncherApi
launcher = LauncherApi() # Uses MLX_USERNAME and MLX_PASSWORD environment variables - alternatively MLX_TOKEN
launcher.ping() # "pong" if successful, raise if the agent is not reachable
# Launch quick profile
# Pass parameters to override the default body defined in...
# mlx/models/profile.py::Profile::__default__
res = launcher.quick({
"parameters": {
"flags": {
"proxy_masking": "custom",
}
}
})
Environment Variables
The following environment variables can be set to configure both SDK and CLI operations:
MLX_USERNAME
: Username for MLX authentication.MLX_PASSWORD
: Password for MLX authentication.MLX_TOKEN
: Token for MLX authentication. ...
Contributing
Contributions are welcome! Please follow the guidelines outlined in the CONTRIBUTING file.
License
This project is released under the MIT License. For more details, refer to the LICENSE file.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
File details
Details for the file multilogin-0.6.71-py3-none-any.whl
.
File metadata
- Download URL: multilogin-0.6.71-py3-none-any.whl
- Upload date:
- Size: 24.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f35e21518639be62d173b2992cb2ae7f359fba02770087fa15199492b4081404 |
|
MD5 | ce1b4edb79f204d9f06e0bb03145b5ee |
|
BLAKE2b-256 | 0b4b2ab9d5c9865e60164b7ad37bff3c6b88bb086107c79371be4887f8b00ca1 |