Feedstock license: BSD-3-Clause
Home: https://usage.jdx.dev/
Package license: MIT
Summary: Usage Spec processor CLI
Development: https://github.com/jdx/usage
Documentation: https://usage.jdx.dev/cli/reference/
Usage is a spec and CLI for defining CLI tools. Arguments, flags, environment variables, and config files can all be defined in a Usage spec. It can be thought of like OpenAPI (swagger) for CLIs. Use it to generate autocompletion scripts, markdown documentation, man pages, and more.
| GitHub Actions |
|
| Azure |
| Name | Downloads | Version | Platforms |
|---|---|---|---|
Installing usage from the conda-forge channel can be achieved by adding conda-forge to your channels with:
conda config --add channels conda-forge
conda config --set channel_priority strict
With conda
conda install usage
With mamba
mamba install usage
With pixi
# for adding to your local project
pixi add usage
# for installing globally
pixi global install usage
It is possible to list all of the versions of usage available on your platform:
With conda
conda search usage --channel conda-forge
With mamba
mamba search usage --channel conda-forge
With pixi
pixi search usage --channel conda-forge
With mamba repoquery, which may provide more information
# Search all versions available on your platform:
mamba repoquery search usage --channel conda-forge
# List packages depending on `usage`:
mamba repoquery whoneeds usage --channel conda-forge
# List dependencies of `usage`:
mamba repoquery depends usage --channel conda-forge
conda-forge is a community-led conda channel of installable packages. In order to provide high-quality builds, the process has been automated into the conda-forge GitHub organization. The conda-forge organization contains one repository for each of the installable packages. Such a repository is known as a feedstock.
A feedstock is made up of a conda recipe (the instructions on what and how to build the package) and the necessary configurations for automatic building using freely available continuous integration services. Thanks to the awesome service provided by Azure, GitHub, CircleCI, AppVeyor, Drone, and TravisCI it is possible to build and upload installable packages to the conda-forge anaconda.org channel for Linux, Windows and OSX respectively.
To manage the continuous integration and simplify feedstock maintenance,
conda-smithy has been developed.
Using the conda-forge.yml within this repository, it is possible to re-render all of
this feedstock's supporting files (e.g. the CI configuration files) with conda smithy rerender.
For more information, please check the conda-forge documentation.
feedstock - the conda recipe (raw material), supporting scripts and CI configuration.
conda-smithy - the tool which helps orchestrate the feedstock.
Its primary use is in the construction of the CI .yml files
and simplify the management of many feedstocks.
conda-forge - the place where the feedstock and smithy live and work to produce the finished article (built conda distributions)
If you would like to improve the usage recipe or build a new
package version, please fork this repository and submit a PR. Upon submission,
your changes will be run on the appropriate platforms to give the reviewer an
opportunity to confirm that the changes result in a successful build. Once
merged, the recipe will be re-built and uploaded automatically to the
conda-forge channel, whereupon the built conda packages will be available for
everybody to install and use from the conda-forge channel.
Note that all branches in the conda-forge/usage-feedstock are
immediately built and any created packages are uploaded, so PRs should be based
on branches in forks, and branches in the main repository should only be used to
build distinct package versions.
In order to produce a uniquely identifiable distribution:
- If the version of a package is not being increased, please add or increase
the
build/number. - If the version of a package is being increased, please remember to return
the
build/numberback to 0.