Skip to main content

A LAN communication platform — chat, files, shell, and more over your local network

Project description

NekoCat 🐱

A LAN communication platform. Chat, share files, send notifications, open remote shells — all over your local network with a single pip install.

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XX  /\_/\  XX  nekocat                   XX
XX ( o.o ) XX  a lan communication       XX
XX  >   <  XX  package                   XX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Quick Start

pip install nekocat
neko setup

That's it. The daemon starts automatically and will restart on every boot.

Commands

Command Description
neko setup First-time setup: generate keys, register autostart, start daemon
neko look Discover NekoCat devices on your LAN
neko throw file.txt Laptop Send a file (or folder) to a device
neko catch Wait for incoming transfers
neko chat Open LAN broadcast chat
neko meow "Hello!" Send a desktop notification
neko shell Laptop Open a remote terminal
neko share ~/Projects Share a folder read-only
neko pair Laptop Pair with a new device
neko open Open the received-files directory
neko logs View transfer, chat, and error history
neko status Show daemon status
neko enable Enable autostart on boot
neko disable Disable autostart on boot
neko uwu

Architecture

neko (CLI)  ──IPC─►  nekod (Daemon)  ──LAN─►  peers
   localhost:54320           port:54322

The CLI never touches the network directly. Every LAN operation is handled by nekod, which runs as a background service.

Security

  • Each installation generates a unique Node ID and an Ed25519 identity key pair.
  • All sessions use X25519 ephemeral key exchange so traffic is encrypted with a fresh key each time.
  • First-time connections show a 6-digit pairing code that must match on both devices.
  • Once paired, devices are trusted automatically.

Configuration

OS Path
Windows %APPDATA%\NekoCat\
Linux ~/.config/nekocat/
macOS ~/Library/Application Support/NekoCat/

Config files:

  • config.json — general settings
  • trusted_peers.json — paired devices and their public keys
  • nekocat.db — SQLite database for peer cache and all logs

License

MIT

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

nekocat-0.1.2.tar.gz (52.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nekocat-0.1.2-py3-none-any.whl (72.1 kB view details)

Uploaded Python 3

File details

Details for the file nekocat-0.1.2.tar.gz.

File metadata

  • Download URL: nekocat-0.1.2.tar.gz
  • Upload date:
  • Size: 52.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for nekocat-0.1.2.tar.gz
Algorithm Hash digest
SHA256 e7b7836f8436397bebe77ae3b794f6e5945bda3486825964b6b99352b7ed7889
MD5 fd7d3e26e7f8dc5cf35228ee0a968d88
BLAKE2b-256 d83f152a0f6b38f8be62b962d8791641b9fe21d2efbf24db4d16f3632d7b0e0c

See more details on using hashes here.

File details

Details for the file nekocat-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: nekocat-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 72.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for nekocat-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 70067db168b668fa2cb2f80e0a3eb2a64aeda281e70026e656e59a4e141ec51f
MD5 28890fa82aa8d9cb74c337b4d9fce758
BLAKE2b-256 151936bf78c437fb74f4f1f02c46f5ad41021b34b65fd415ec22a6d38ccb6dea

See more details on using hashes here.

Supported by

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