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: 5 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 (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-20T19:52:32.000Z (about 1 year ago)
- Last Synced: 2025-03-28T19:51:40.304Z (about 1 year 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
- awesome-cli-apps-in-a-csv - Instagram CLI - Instagram from your terminal; It allows you to use social media more intentionally (chat, stay updated with post and stories without falling into endless brainrot). (<a name="chat"></a>Chat and instant messaging)
- awesome - supreme-gg-gg/instagram-cli - Instagram's CLI and TUI client -- The ultimate weapon against brainrot (TypeScript)
- awesome-tuis - instagram-cli
- awesome-cli-apps - Instagram CLI - Instagram from your terminal; It allows you to use social media more intentionally (chat, stay updated with post and stories without falling into endless brainrot). (<a name="chat"></a>Chat and instant messaging)
README
# Instagram CLI
The ultimate weapon against brainrot. The fastest, lightest, and most portable Instagram client.
$$
\text{Instagram}_{\text{CLI}} = \lim_{\text{screen time} \to 0} \text{Productivity} \to \infty
$$
[](https://www.npmjs.com/package/@i7m/instagram-cli)
[](https://www.npmjs.com/package/@i7m/instagram-cli)
[](https://pepy.tech/projects/instagram-cli)
[](https://aur.archlinux.org/packages/instagram-cli)
[](https://github.com/supreme-gg-gg/instagram-cli/issues)
https://github.com/user-attachments/assets/fb25cc5f-a868-487d-b853-a7bbe77ba348
> [!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.
## Why Instagram CLI?
Empower yourself to become a 10x Instagrammer by minimizing distractions, enabling 100% keyboard control, and accessing it from any terminal — whether in your VSCode editor or your Linux server.
Instagram CLI allows you to use social media more intentionally -- to stay connected with people you care about rather than being exploited for your attention.
- Chat with your friends without falling into endless brainrot
- Stay updated with post and stories from people around you
- Focus on meaningful, intentional conversations and be productive
- Full keyboard navigation and shortcuts, no mouse, no touchscreens
- Celebrate the art and simplicity of **terminal UI (TUI)**
## Installation (TypeScript Client)
### NPM
Requires Node.js v20 or higher.
```bash
npm install -g @i7m/instagram-cli
```
### Homebrew (macOS/Linux)
```bash
brew tap supreme-gg-gg/tap
brew install instagram-cli
```
The formula is available [here](https://github.com/supreme-gg-gg/homebrew-tap/blob/main/Formula/instagram-cli.rb).
### Community Packages
The following packages are supported by the community. The maintainers of Instagram CLI do not provide support for these packages.
#### AUR (Arch Linux)
```bash
yay -S instagram-cli
```
#### Snap (Linux)
```bash
snapcraft pack
sudo snap install instagram-cli_1.4.0_amd64.snap --dangerous
snap run instagram-cli.instagram-cli
# OR, since /snap/bin is in PATH
instagram-cli
```
We welcome contributions to add more installation methods.
For installation from source, please refer to the [TypeScript Client Documentation](./DEVELOPMENT.md).
## Installation (Python Client)
The Python client is the original implementation of `instagram-cli` with nostalgic UNIX vibes.
```bash
pip install instagram-cli
```
Note that Python links to the `instagram` command, while TypeScript links to `instagram-cli`.
> [!CAUTION]
> We do not recommend using the TypeScript and Python client simultaneously with the same account to reduce the risk of account bans. We recommend using the TypeScript client when possible since it is much less likely to trigger Instagram's anti-bot mechanisms.
For more information about the Python client, please refer to the [Python Client Documentation](./instagram-py/README.md).
## Commands
The following commands will be available after installing the package:
```bash
instagram-cli # display title art
instagram-cli --help # view available commands
# Authentication
instagram-cli auth login --username # login with username and password
instagram-cli auth logout # logout and removes session
instagram-cli auth switch # switch to another saved account
instagram-cli auth whoami # display current default user
# Core features
instagram-cli chat -u -t # start chat interface
instagram-cli feed # view posts from people you follow
instagram-cli stories # view stories from people you follow (BETA)
instagram-cli notify # view notifications (inbox, followers, mentions)
# Modify configuration
instagram-cli config # lists all config
instagram-cli config # set config key to value
instagram-cli config edit # open config file in editor
```
> [!TIP]
> You can easily manage multiple accounts with Instagram CLI!
> Your login for each account will be saved **locally** and you can switch between them using the `instagram-cli auth switch ` command or run a certain command with a specific account using the `--username` flag.
## Chat Commands
Inside the chat interface and after selecting a thread, you can navigate all interface with 100% keyboard support. When messaging, the following commands are available:
```bash
# Select messages to perform actions
:select
:react
:reply
:unsend
# Media Handling
:upload
:download # Requires :select first to select message
# Navigation
:k # go up
:K # go to top
:j # go down
:J # go to bottom
```
> [!TIP]
> You can quickly include text files or images in a message by using `#` followed by the file path. For example, `#path/to/file.txt` or `#path/to/image.png`.
> Use `tab` and `enter` to autocomplete file paths. You can include emojis in messages with `:emoji_name:` e.g. `:thumbsup:` = 👍 (with fuzzy matching).
## Configuration
You can view and modify configuration with `instagram-cli config`. The configuration file is located at `~/.instagram-cli/config.ts.yaml`. The following are common configuration options:
| Key | Type | Default | Description |
| -------------- | ------ | ----------- | ----------------------------------------------------------------------------------------------------------- |
| image.protocol | string | "halfBlock" | Protocol for rendering images. Options: "ascii", "halfBlock", "braille", "kitty", "iterm2", "sixel", or "". |
| feed.feedType | string | "list" | Layout of feed display. Options: "timeline", "list", "". |
> [!NOTE]
> We automatically select the best image protocol based on your terminal. If you experience issues with image rendering, try changing the `image.protocol` setting. Make sure this is supported by your terminal (e.g. `sixel` and `iterm2` protocols won't work in Kitty).
## Contributing
We welcome contributors! Please see the comprehensive [CONTRIBUTING.md](CONTRIBUTING.md) file for details on how to get started, create issues, and submit pull requests. It is very important that you follow these instructions because we manage two different clients in the same repository. _Instagram CLI is NOT meant to be used for bot-behaviours, we will not accept contributions that add such features._
### Reporting Issues
Occasionally, Instagram may update their API or protocols which can cause certain features to break. If you encounter any issues, please report them on our [GitHub Issues page](https://github.com/supreme-gg-gg/instagram-cli/issues). Make sure to attach the relevant log files located at `~/.instagram-cli/logs/` to help us diagnose and fix the problem quickly. You may want to redact sensitive data like your username for privacy.
### Sister projects
We contributed the following extensions to the Ink ecosystem for building Terminal UI apps:
- [Ink Picture, Ink-native image component](https://github.com/endernoke/ink-picture)
- [Wax, Ink routing framework](https://github.com/endernoke/wax).
## Star History
[](https://www.star-history.com/#supreme-gg-gg/instagram-cli&type=date&legend=top-left)