Skip to main content

You have been nixt.

Project description

NAME

NIXM - You have been nixt.

SYNOPSIS

nixm  <cmd> [key=val] [key==val]
nixmc [-i] [-v]
nixmd
nixms

DESCRIPTION

NIXM can connect to IRC, fetch and display RSS feeds, take todo
notes and log text. You can also copy/paste the service file and
run it under systemd for 24/7 presence in a IRC channel.

INSTALL

installation is done with pipx

$ pipx install nixm
$ pipx ensurepath

USAGE

without any argument the bot does nothing

$ nixm
$

see list of commands

$ nixm cmd
cfg,cmd,dne,dpl,err,exp,imp,log,mod,mre,nme,
pwd,rem,req,res,rss,srv,syn,tdo,thr,upt

start a console

$ nixmc
>

use -v to enable verbose

$ nixmc -v
NIXT since Tue Sep 17 04:10:08 2024
>

use -i to init modules

$ nixmc -i
>

start daemon

$ nixmd
$

start service

$ nixms
<runs until ctrl-c>

CONFIGURATION

irc

$ nixm cfg server=<server>
$ nixm cfg channel=<channel>
$ nixm cfg nick=<nick>

sasl

$ nixm pwd <nsvnick> <nspass>
$ nixm cfg password=<frompwd>4

rss

$ nixm rss <url>
$ nixm dpl <url> <item1,item2>
$ nixm rem <url>
$ nixm nme <url> <name>

opml

$ nixm exp
$ nixm imp <filename>

SYSTEMD

$ nixm srv > nixm.service
$ sudo mv nixm.service /etc/systemd/system/
$ sudo systemctl enable nixm --now

joins #nixm on localhost

COMMANDS

here is a list of available commands

cfg - irc configuration
cmd - commands
dpl - sets display items
err - show errors
exp - export opml (stdout)
imp - import opml
log - log text
mre - display cached output
pwd - sasl nickserv name/pass
rem - removes a rss feed
res - restore deleted feeds
rss - add a feed
srv - create service file
syn - sync rss feeds
tdo - add todo item
thr - show running threads

SOURCE

source is at ``https://github.com/otpcr/nixm``

FILES

~/.nixm
~/.local/bin/nixm   (cli)
~/.local/bin/nixmc  (console)
~/.local/bin/nixmd  (daemon)
~/.local/bin/nixms  (service)
~/.local/pipx/venvs/nixm/*

AUTHOR

Bart Thate <record11719@gmail.com>

COPYRIGHT

NIXM is Public Domain.

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

nixm-2.tar.gz (16.5 kB view details)

Uploaded Source

File details

Details for the file nixm-2.tar.gz.

File metadata

  • Download URL: nixm-2.tar.gz
  • Upload date:
  • Size: 16.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for nixm-2.tar.gz
Algorithm Hash digest
SHA256 89ad872da9077ce1a822c6e4e4d89773afeb558fe26be5bb31987563729182f4
MD5 39dbbc7982a3299b170583e6fe14e407
BLAKE2b-256 4a5e687f8908ccb482b31539fba162eb900844eee818437bd04743c001b9dbf5

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