Metadata-Version: 2.4
Name: neodb-rest-cli
Version: 0.1.0
Summary: Generated NeoDB REST CLI for catalog, shelf, collection, review, and tag workflows
Project-URL: Homepage, https://github.com/shivaam/openapi-cli-gen
Project-URL: Source, https://github.com/shivaam/openapi-cli-gen/tree/main/wrappers/neodb-rest-cli
Project-URL: Issues, https://github.com/shivaam/openapi-cli-gen/issues
Project-URL: Generator, https://github.com/shivaam/openapi-cli-gen
Author: Shivam Rastogi
License: MIT
Keywords: api,cli,generated,openapi,rest
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Requires-Dist: openapi-cli-gen>=0.0.20
Description-Content-Type: text/markdown

# neodb-rest-cli

Generated CLI for the [NeoDB](https://neodb.net) REST API.

This wrapper is built from the public OpenAPI spec at
`https://neodb.social/api/openapi.json` using
[`openapi-cli-gen`](https://github.com/shivaam/openapi-cli-gen).

## Install

```bash
pipx install neodb-rest-cli
```

The generated package defaults to:

```bash
https://neodb.social
```

Override the target instance with:

```bash
export NEODB_REST_CLI_BASE_URL=https://your.instance
```

## Examples

Public/read-only catalog and trending commands:

```bash
neodb-rest-cli catalog search-item --query Dune --category book --output-format json
neodb-rest-cli trending book --output-format json
neodb-rest-cli trending movie --output-format json
```

The public search example currently returns populated catalog data on
`https://neodb.social`, including `data`, `pages`, and `count` fields.

Authenticated personal-data workflows:

```bash
neodb-rest-cli shelf list-marks-on --type book --output-format json
neodb-rest-cli tag list --output-format table
neodb-rest-cli collection list-user --output-format json
```

## Auth

NeoDB exposes bearer/OAuth-style auth in its spec. Set a token when calling
authenticated endpoints:

```bash
export NEODB_REST_CLI_TOKEN=...
```

## Notes

This is an unofficial community wrapper. Start with read-only commands before
testing shelf, review, note, tag, or collection writes against personal data.
