Skip to main content

Plutus Terminal is a powerful open-source crypto news trading terminal with the focus on Perpetuals DEX.

Project description

Plutus Terminal Splash Screen

Plutus Terminal

What is Plutus Terminal? 🌟

Plutus Terminal Splash Screen

Plutus Terminal is a powerful open-source crypto news trading terminal focused on Perpetuals DEX. Designed to be user-friendly, it allows you to trade using real-time news updates, control positions, and manage multiple DEXs.

Embracing the web3 mentality, Plutus Terminal ensures you are always in control of your keys, handles everything locally, and interacts directly with the DEX contracts.

Features 🎯

  • 💻 Runs locally on your computer
  • 🌐 Cross-platform (Windows, Linux, MacOS)
  • 🔄 Integrates TreeOfAlpha and PhoenixNews
  • 🛠️ Highly customizable news filters
  • 🔔 Never miss news with desktop notifications
  • 💎 Open-source and free
  • 🌍 Use your own RPC nodes

⚠️ Disclaimer

Plutus Terminal is in alpha version and it's more likely to break. It trades on the Perpetuals DEX using real money. Do not risk money you cannot afford to lose.

PLUTUS TERMINAL IS PROVIDED "AS IS". USE THE SOFTWARE AT YOUR OWN RISK. The authors and all affiliates assume no responsibility for your trading results. The entire risk as to the quality and performance of the program is with you. Should the program prove defective, you assume the cost of all necessary servicing, repair, or correction.

Everyone is encouraged to read and understand the source code before using it. Positions opened with Plutus Terminal will automatically use our referral codes when possible.

🛠️ Installation

Plutus Terminal is a Python package with multiple dependencies. You can install it by downloading the PyApp executable, using pipx, or building it with Poetry.

[!WARNING] The following instructions will show how to install Plutus Terminal unstable version! Unstable version is more likely to break.

Installation using PyApp executable:

PyApp

To install

Download the plutus-terminal executable from the Releases page and run it directly.

To update

From the terminal run:

<plutus_terminal_executable> self update

To uninstall

<plutus_terminal_executable> self remove

[!NOTE] To learn more about PyApp, check out the PyApp documentation



Installation using pipx:

Pipx

To install

pipx install plutus-terminal

Run with:

plutus-terminal

To update

pipx upgrade plutus-terminal

Installation using Poetry:

Poetry

To install

First, clone the repository:

git clone https://github.com/plutus-terminal/plutus-terminal.git

Navigate to the cloned repository:

cd plutus-terminal

Checkout the unstable branch:

git checkout unstable

Then, install the package:

poetry install

Run the tool with:

poetry run plutus-terminal

To update

git pull
poetry update

🚀 Quick Start

Bellow you will find a simple guide on how to get started with Plutus Terminal. For a more complete documentation please refer to the documentation

Create new account

When opening the terminal the first time, you will be prompted to create an account.

See image...
Create Account

> [!NOTE] > The same private key can be used to create multiple accounts on different > exchanges.

Fill the form with the required information and press Create New Account.

[!CAUTION] The private key will be stored in the OS keyring, always ensure your OS is secure.

News quick market buy

Once the account is created you should see the terminal opening after a couple of seconds.

News will be presented in real-time under the News Feed widget, if the coins associated with the news are available on the selected exchange you will see a quick trade group appear on the news.

See image...
News with quick buy trades.

[!NOTE] Quick Market Buy values represent the amount of capital that will be used to open your position. This value get's multiplied by the current pair leverage to determine the size of the position.

Auto TP/SL

Quick Market buys can be configured with TP and SL values. For that you will need to open the configuration window by pressing the gear icon on the top right corner.

Once the window is open, you can set the TP and SL values on the Trade tab.

See image...
Auto TP/SL

[!NOTE] Each account have their own TP and SL values

News Filters

You can configure the news filters by clicking on the Filters tab in the configuration window.

There are 2 types of filters Keyword Matching and Data Matching. Both of them allow actions to happen when the conditions are meet.

Posible actions are:

Action Description
Sound Association Play a specific sound
Coin Association Associate a coin to the news
Ignore News Don't display the news

Keyword Matching

The Keyword Matching filter allows you to filter specific keywords in the news body if the keyword is present the selected action will run on the news.

Example
Keyword Matching
This filter will play the `pause` sound if the word `Foxify` is present in the news body and it will color that word dark pink.

Data Matching

The Data Matching filter allows you to filter for word on specific data fields if the word is present in the specified datafield then the selected action will run on the news.

Example
Data Matching
This filter will play the `powerup` sound if the title of the news is `Tree News (@News_Of_Alpha)`

[!NOTE] Filters will only be saved if the Save Filters button is pressed and will only be applied after a restart.

Hotkey Shortcuts

Hotkey Action
w Move selected new 1 up
s Move selected new 1 down
q Move selected to the top
\ Open token modal search
Ctrl+j or UP (Only on modal search) Move modal auto complete selection down
Ctrl+k or DOWN (Only on modal search) Move modal auto complete selection down

🌐 Exchanges

Current supported exchanges are:

Planned support:

❤️ Support

If this project was helpful, please consider supporting by:

Every bit helps. Thank you!

📜 License

Plutus Terminal is licensed under the GNU General Public License version 3.0

See LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

plutus_terminal-0.1.0a1.tar.gz (6.5 MB view details)

Uploaded Source

Built Distribution

plutus_terminal-0.1.0a1-py3-none-any.whl (6.6 MB view details)

Uploaded Python 3

File details

Details for the file plutus_terminal-0.1.0a1.tar.gz.

File metadata

  • Download URL: plutus_terminal-0.1.0a1.tar.gz
  • Upload date:
  • Size: 6.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.2 Linux/5.15.153.1-microsoft-standard-WSL2

File hashes

Hashes for plutus_terminal-0.1.0a1.tar.gz
Algorithm Hash digest
SHA256 a5f3e7ebc05214f3ef25b2b1aacc5a6c1a03bc8f8e0262f3e51e70cd82758b31
MD5 e3ac277f358b497304efef99416f86e8
BLAKE2b-256 53dafed4cde21ac286d74a07e659991008eb324274c1bfbda0aaa18397d65808

See more details on using hashes here.

File details

Details for the file plutus_terminal-0.1.0a1-py3-none-any.whl.

File metadata

  • Download URL: plutus_terminal-0.1.0a1-py3-none-any.whl
  • Upload date:
  • Size: 6.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.2 Linux/5.15.153.1-microsoft-standard-WSL2

File hashes

Hashes for plutus_terminal-0.1.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 e51e4b2e047ac6900261cac826bb4007695badfb83a3473f41b65e21715bbc66
MD5 c2081ed0088f58dad498c4add6c4e885
BLAKE2b-256 f4f8dd99e3c31d8e2457936b27e26181ca13df063cf4513399ac8e3fb42a7fe2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page