kdeets 0.1.17

Query crates.io for information about a crate.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

# kdeets

[![Crates.io][crates-badge]][crates-url]
[![MIT licensed][mit-badge]][mit-url]
[![Build Status][circleci-badge]][circleci-url]
[![Rust 1.85+][version-badge]][version-url]
[![Docs][docs-badge]][docs-url]
[![BuyMeaCoffee][bmac-badge]][bmac-url]
[![GitHubSponsors][ghub-badge]][ghub-url]

[crates-badge]: https://img.shields.io/crates/v/nextsv.svg
[crates-url]: https://crates.io/crates/nextsv
[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
[mit-url]: https://github.com/jerusdp/nextsv/blob/main/LICENSE
[circleci-badge]: https://dl.circleci.com/status-badge/img/gh/jerus-org/kdeets/tree/main.svg?style=svg
[circleci-url]: https://dl.circleci.com/status-badge/redirect/gh/jerus-org/kdeets/tree/main
[version-badge]: https://img.shields.io/badge/rust-1.85+-orange.svg
[version-url]: https://www.rust-lang.org
[docs-badge]:  https://docs.rs/kdeets/badge.svg
[docs-url]:  https://docs.rs/kdeets
[bmac-badge]: https://badgen.net/badge/icon/buymeacoffee?color=yellow&icon=buymeacoffee&label
[bmac-url]: https://buymeacoffee.com/jerusdp
[ghub-badge]: https://img.shields.io/badge/sponsor-30363D?logo=GitHub-Sponsors&logoColor=#white
[ghub-url]: https://github.com/sponsors/jerusdp

A utility to query crates.io for information about a crate.

## Feature set

- [x] Versions for a crate
- [x] Rust versions for dependencies
- [x] Setup limited clone for testing

## Installation

Install the CLI using cargo install.

```sh
cargo install kdeets

```

Check program is available and the version installed.

```console
$ kdeets --version
kdeets 0.1.17

```

## Usage

The available commands can be seen by running the command with the help flag.

```sh
$ kdeets --help
Query crates.io for information about a crate.

Usage: kdeets [OPTIONS] <COMMAND>

Commands:
  crate  Query crates.io for information about a crate
  rust   Query crates.io for maximum Rust version for a crate
  setup  Setup local registry for a crate
  help   Print this message or the help of the given subcommand(s)

Options:
  -v, --verbose...  Increase logging verbosity
  -q, --quiet...    Decrease logging verbosity
  -h, --help        Print help
  -V, --version     Print version

```

### Versions for a crate  (cmd: crate)

Display the key versions for the crate.

```console
$ kdeets crate -h
Query crates.io for information about a crate

Usage: kdeets crate [OPTIONS] <CRATE>

Arguments:
  <CRATE>  The name of the crate

Options:
  -v, --verbose...  More output per occurrence
  -q, --quiet...    Less output per occurrence
  -e, --earliest    First version ever published. May be yanked
  -n, --normal      Returns crate version with the highest version number according to semver, but excludes pre-release and yanked versions
  -t, --top         The highest version as per semantic versioning specification
  -r, --recent      The last release by date, even if it’s yanked or less than highest version
  -l, --list        List all versions of the crate
  -k, --key         List key values (equivalent to `-entr`)
  -a, --all         List all versions and key values (equivalent to `-entrl`)
  -h, --help        Print help
  -V, --version     Print version

```

This command queries crates.io for information about a crate and reports based on the options selected.

Crates.io tracks for each crate the following versions:

- `earliest`: The first version ever published. May be yanked.
- `normal`: Returns crate version with the highest version number according to semver, but excludes pre-release and yanked versions.
- `top`: The highest version as per semantic versioning specification.
- `recent`: The last release by date, even if it’s yanked or less than highest version.

The `key` option lists all of these versions (equivalent to `-entr`).

The command can create a table listing the yank status and version for all versions of the crate.

The `all` option lists all versions and key values (equivalent to `-entrl`).

```console
$ kdeets --no-colour crate -entrl some_crate

 Crate versions for some_crate.
 🭶🭶🭶🭶🭶🭶🭶🭶🭶🭶🭶🭶🭶🭶🭶🭶🭶🭶🭶🭶🭶🭶🭶🭶🭶🭶🭶🭶🭶🭶
   Earliest version: 0.1.0
   Highest normal version: 0.2.1
   Highest version: 0.2.1
   Most recent version: 0.2.1
    Yanked  Version 
       No     0.1.0
       No     0.1.1
       No     0.1.3
       No     0.2.1


```

## License

Licensed under the MIT license (LICENSE-MIT or <http://opensource.org/licenses/MIT>).