Metadata-Version: 2.4
Name: bejw
Version: 0.6.0
Summary: A capped reading list for links that shimmer
Author: menisadi
License: MIT License
        
        Copyright (c) 2026 menisadi
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/menisadi/bejw
Project-URL: Repository, https://github.com/menisadi/bejw
Project-URL: Changelog, https://github.com/menisadi/bejw/blob/main/CHANGELOG.md
Keywords: cli,reading-list,links,productivity
Requires-Python: >=3.13
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: rich>=14.3.2
Requires-Dist: typer>=0.21.1
Dynamic: license-file

<div align="center">

# bejw

`A capped reading list in your terminal.`

</div>

## Install

```bash
uv tool install bejw
```

Or with pip:

```bash
pip install bejw
```

## Quick start

```bash
bejw init                # create a reading list (default capacity: 10)
bejw add URL TITLE       # save a link
bejw list                # show unread links
```

## Commands

```bash
bejw init [--capacity N]       # initialize the reading list (confirms if one exists)
bejw init --force              # overwrite an existing list without confirming
bejw add URL TITLE             # add a link (prompts to replace one if full)
bejw list                      # display unread links
bejw list --include-read       # include read links
bejw list --format tsv|csv|jsonl  # alternate output formats
bejw list --color always       # force colors (useful when piping to less -R)
bejw read N                    # open link #N in the browser
bejw mark-read N               # mark link #N as read
bejw remove N                  # remove link #N
bejw capacity                  # show current capacity
bejw capacity N                # set capacity to N (see Capacity below)
bejw clear                     # remove all links
```

## Capacity

The cap is the point of the tool, so raising it has one rule: **you cannot raise
capacity while the list is full.** Mark something read first.

```bash
$ bejw capacity 15
Reading list is full. Mark something read before raising capacity.
```

Lowering is always allowed, and raising works normally whenever there is
headroom — so deciding "10 was the wrong number for me" costs nothing. What the
rule blocks is the reflexive raise: hitting a full list mid-flow and moving the
cap instead of reading something.

Every change is recorded, and `bejw capacity` reports the last one on stderr so
drift stays visible while the bare number stays pipe-friendly:

```bash
$ bejw capacity
15
(raised from 10, 3 days ago)
```

`init` is the other way to reset the cap, so it now shows what it is about to
discard and asks first. Use `--force` to skip the prompt in scripts:

```bash
$ bejw init --capacity 20
~/.bejw/links.json already holds 8 links (6 unread) with capacity 10.
Discard them and start over? [y/N]:
```

## Storage

Data is stored in `~/.bejw/links.json` by default. All commands accept `--file-path` to use a different location.
