https://github.com/supreme-gg-gg/instagram-cli
The ultimate weapon against brainrot
https://github.com/supreme-gg-gg/instagram-cli
brainrot cli command-line-tool curses curses-ui instagram instagram-api messenger productivity python terminal-ui tui typer
Last synced: 2 months ago
JSON representation
The ultimate weapon against brainrot
- Host: GitHub
- URL: https://github.com/supreme-gg-gg/instagram-cli
- Owner: supreme-gg-gg
- License: mit
- Created: 2025-02-01T02:40:41.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-03-20T19:52:32.000Z (3 months ago)
- Last Synced: 2025-03-28T19:51:40.304Z (3 months ago)
- Topics: brainrot, cli, command-line-tool, curses, curses-ui, instagram, instagram-api, messenger, productivity, python, terminal-ui, tui, typer
- Language: Python
- Homepage: https://pypi.org/project/instagram-cli/
- Size: 21.9 MB
- Stars: 47
- Watchers: 4
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Instagram CLI
The ultimate weapon against brainrot.
[](https://pepy.tech/projects/instagram-cli)
[](https://github.com/supreme-gg-gg/instagram-cli/blob/main/LICENSE)
[](https://github.com/supreme-gg-gg/instagram-cli/issues)
https://github.com/user-attachments/assets/e9206e14-8141-49b2-8e2c-17c76402e3cb
The world's first open-source CLI (command line interface) + Terminal UI client for Instagram.
> [!WARNING]
> This project is not affiliated with, authorized, or endorsed by Instagram. This is an independent and unofficial project. Using it might violate Meta's Terms of Service. Use at your own risk.
## What does it do?
- We transform Instagram from a brainrot hell into productivity tool
- We give back control of social media to the user
- We enable user to do more with less
- We celebrate the art and simplicity of terminal UI
- We preserve the core of social media and protect your attention
> [!TIP]
> Use Instagram with 100% keyboard control - no mouse clicks or touchscreen taps needed! Perfect for developers and Linux users who love staying on the keyboard 🤣
## Installation
The simplest way to get started is to install the package from PyPI if you have Python installed:
```bash
pip install instagram-cli
```
If you do not have Python installed, you can download and install it from the [official website](https://www.python.org/downloads/).
### Installation from Source
```bash
git clone https://github.com/supreme-gg-gg/instagram-cli.git
cd instagram-cli
pip install .
```
### Pre-built Executables
> [!CAUTION]
> This option is **not recommended** unless the other methods do not work for you.
We no longer provide pre-built executables. If you want to run the application in an environment without Python, you can build the executable yourself with `pyinstaller`. We recommend using the `instagram-cli.spec` file we provided.
```bash
pyinstaller --onedir instagram-cli.spec
```
This will generate the executable in the `dist/` directory.
```bash
./instagram-cli [OPTIONS] command [ARGS] # for macOS and Linux
instagram-cli.exe [OPTIONS] command [ARGS] # for Windows
```
> [!CAUTION]
> Starting from Version 1.3, Windows support will be discontinued due to incompatibilities between the `curses` and `windows-curses` libraries. While the application may still work on Windows, we will no longer be testing or maintaining Windows-specific functionality. We recommend using WSL (Windows Subsystem for Linux) or Docker for Windows users.
## Commands
The following commands will be available after installing the package:
```bash
instagram # display title art
instagram --help # view available commands
# Authentication
instagram auth login -u # login with username and password
instagram auth logout # logout and removes session
# Chat Features
instagram chat start # start chat interface
instagram chat search -u # search and open chat by username
instagram chat search -t # search and open chat by chat title
# Utility Commands
instagram notify # view notifications (inbox, followers, mentions)
instagram schedule ls # view scheduled messages
instagram stats --days # view usage analytics (default: 14 days)
instagram config --get --set --edit # manage custom configuration
instagram cleanup -t # cleanup media and session cache files
```
> [!NOTE]
> All searches in the package uses a custom fuzzy matching based on ratcliff/obershelp similarity algorithm. This means chat search and emoji search will be more flexible and forgiving.
## Chat
The chat interface is the main feature of this package. It allows you to interact with your Instagram chats in a terminal-based interface.
In the chat list page, use arrow keys (or 'j', 'k') + Enter to select a chat. You can also search for user by username using @user_name + Enter.
> [!NOTE]
> Chat commands (prefixed with `:`) are NOT available in the chat menu page. You must enter a chat to use chat commands.
After entering the chat page, you can type messages as usual and send them with Enter. You can also use chat commands to supercharge your chat experience.
> [!TIP]
> Press Enter in the middle of a message to insert a line break, and at the very end to send it.
### Chat Commands
All chat commands have the following syntax:
```bash
:command
```
> [!IMPORTANT]
> Long arguments should have special enclosures such as `"..."` for strings with spaces and `$...$` for LaTeX code.
- `:help`: view available commands
- `:quit`: quit the application
- `:back`: back to chat menu for selecting chat
- `:reply`: reply mode to select and reply to messages
- `:scrollup`or `:k`: scroll up in chat messages
- `:scrolldown` or `:j`: scroll down in chat messages
- `:schedule
### Emoji
Text with emoji syntax will be rendered as emoji. For example,
`This is an emoji :thumbsup:`
will be rendered as
`This is an emoji 👍`
> ![TIP]
> This does not have to be an exact match with the emoji name. For example, `:thumbsup:` can also be written as `:thumbs_up:`.
### LaTeX
We support LaTeX rendering and sending as images in the chat. For example,
`:latex $\frac{a}{b} + c = d$`
```bash
:latex $\left( \begin{bmatrix} a & b \\ c & d \end{bmatrix} \cdot \begin{bmatrix} e & f \\ g & h \end{bmatrix} \right) + \begin{bmatrix} i & j \\ k & l \end{bmatrix}^{-1} \times \left( \int_0^1 x^2 \, dx \right) + \begin{bmatrix} \sin(\theta) & \cos(\theta) \\ \tan(\phi) & \ln(\psi) \end{bmatrix}$
```
Please note that the LaTeX code **_MUST_** be enclosed in `$` symbols.
You can choose to render with [online API](https://latex.codecogs.com) (default) or local LaTeX installation such as TeX Live, MiKTeX, etc. You can set the rendering method with `instagram config --set latex_rendering_method `.
### Scheduling Messages
You can schedule messages to be sent at a later time. The syntax is as follows:
```bash
:schedule ""
```
If the date is not provided, the message will be scheduled for the current day. Input format must be either YYYY-MM-DD HH:MM or HH:MM. **The time must be in 24-hour format, otherwise you might run into warnings for scheduling messages in the past.**
> [!IMPORTANT]
> If you exit the app, the scheduled messages will not be sent but will be restored when you open the app again. You will be prompted by a notification to decide whether to send the scheduled messages or not. We might include system background service in the future to send scheduled messages even when the app is closed.