Guide Set up and automate Newskite.
From the first server to a scripted download: what to enter, what each option does, and where Newskite keeps things.
Your news server
Newskite needs one account with a Usenet provider. Open Settings (the gear, or Ctrl+,) and under Connection enter what the provider gave you:
| Field | What to enter |
|---|---|
| Host | The provider's news server address |
| Port and TLS | 563 with TLS on (the usual choice), or 119 without encryption |
| Username and password | Your account's sign-in |
| Connections | How many connections your plan allows at once |
Test connects, signs in and shows the server's actual replies, so a wrong password or port shows up before the first download.
Fail-over servers
Add a second server and it becomes the fail-over: Newskite asks it only for the articles the first one lacks. Make primary moves a server to the top. A failed job can be retried on the backup with one click; completed files are kept and only what is incomplete is downloaded again.
Adding NZB files
- Add NZB, or Ctrl+O, opens the file picker (several files at once).
- Drop
.nzbfiles, or a folder of them, on the window. - Copy files in your file manager and press Ctrl+V in Newskite.
- Open an
.nzbfile or annzb:link: it is queued in the window you already have.
Web links to NZB files are recognized but not fetched; download the file first.
Watch folder
Set a watch folder in Settings and turn it on. Newskite checks it at the interval you choose and queues every new .nzb file it finds, once. The sidebar's Watch folder entry scans it at once.
After the download
Each job is verified against its PAR2 data, repaired if it needs it, and its archives are extracted. Settings has switches for extracting, deleting archives after a successful extraction, removing leftover files, and stopping downloads that cannot be repaired. Password-protected archives ask for their password in the job's row or its detail pane.
Headless: the command line
The same queue runs without a window:
newskite --headless --nzb one.nzb --nzb two.nzb
With no --server it uses the servers saved in the app's settings. To name one for this run only:
NEWSKITE_PASS='your password' newskite --headless \
--nzb release.nzb --dest ~/Downloads/Newskite \
--server news.example.com:563 --tls --user alice --connections 20
| Option | Meaning |
|---|---|
--nzb FILE | An NZB file to download; repeat it for several |
--dest DIR | Download folder for this run (default: the one in the app's settings) |
--server HOST:PORT | News server for this run; not saved. The port defaults to 563 with --tls, 119 without |
--tls | Use TLS for --server |
--user U, --pass P | Sign-in for --server. Prefer the NEWSKITE_PASS environment variable: a password on the command line is visible to other users in the process list |
--connections N | Simultaneous connections (1 to 500) |
--retries N | Retries per article for transient errors (0 to 100) |
--db DIR | Database folder (default: the app's data folder) |
It prints one queued line per NZB, then complete or failed with the reason for each job.
| Exit code | Meaning |
|---|---|
0 | Every job of the run completed |
1 | At least one job failed |
2 | A usage error, including no usable server |
130 | Interrupted with Ctrl+C; unfinished jobs stay queued and resume on the next run |
Only one Newskite process can use a data folder at a time. While the window is open, a headless run on the same folder exits with an "another Newskite instance" error; give it its own with --db.
Where things are kept
| System | Database folder |
|---|---|
| Linux | ~/.local/share/newskite/db |
| Windows | %APPDATA%\innerpulse\Newskite |
Settings, the queue and the history are in one SQLite database there. Server passwords and archive passwords are stored in it unencrypted; on Linux the files are readable only by your user. Passwords given to a headless run are kept in memory only and never written to the database or the log.
Keyboard
| Keys | What they do |
|---|---|
| Ctrl+O | Choose NZB files |
| Ctrl+V | Add .nzb files copied in the file manager |
| Ctrl+F | Focus the name filter, or the search on the Log view |
| Ctrl+1, Ctrl+2, Ctrl+3 | Queue, History, Log |
| Ctrl+, | Settings; Ctrl+S there saves and closes |
| ↑ ↓ Home End | Walk the rows on screen |
| Space | Start, pause or retry the selected job |
| Alt+↑, Alt+↓ | Move the selected job in the queue |
| Delete | Ask to remove the selected job; Enter confirms |
| Esc | Close one thing: a dialog, an inline editor or confirmation, then the selection |