geodb_cli/lib.rs
1//! geodb-cli
2//! ==========
3//!
4//! Command-line interface for the `geodb-core` geographic database.
5//!
6//! This crate primarily provides a binary (`geodb-cli`). We include a small
7//! library target so that docs.rs renders a documentation page and shows this
8//! overview. See the README for full usage examples.
9//!
10//! Quick start
11//! -----------
12//!
13//! Install the CLI from crates.io:
14//!
15//! ```text
16//! cargo install geodb-cli
17//! ```
18//!
19//! Basic usage:
20//!
21//! ```text
22//! geodb-cli --help
23//! geodb-cli stats
24//! geodb-cli find-country US
25//! geodb-cli list-cities --country US --state CA
26//! ```
27//!
28//! For programmatic access to the data structures and APIs, use the
29//! [`geodb-core`] crate directly.
30//!
31//! Links
32//! -----
33//! - Repository: <https://github.com/holg/geodb-rs>
34//! - Core crate: <https://docs.rs/geodb-core>
35//!
36#![cfg_attr(docsrs, feature(doc_cfg))]
37
38// This library target intentionally exposes no API; the binary is the primary
39// deliverable. The presence of this file enables a rendered page on docs.rs.