https://github.com/defstream/kickable-rs
Can you kick it?
https://github.com/defstream/kickable-rs
it kickable rust
Last synced: 7 months ago
JSON representation
Can you kick it?
- Host: GitHub
- URL: https://github.com/defstream/kickable-rs
- Owner: defstream
- License: other
- Created: 2022-12-22T16:41:45.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-17T11:13:34.000Z (7 months ago)
- Last Synced: 2025-03-24T01:52:11.689Z (7 months ago)
- Topics: it, kickable, rust
- Language: Rust
- Homepage:
- Size: 12.1 MB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-ccamel - defstream/kickable-rs - Can you kick it? (Rust)
README
[](https://crates.io/crates/kickable)
[](https://github.com/defstream/kickable-rs/actions/workflows/main.yml)
[](https://dl.circleci.com/status-badge/redirect/gh/defstream/kickable-rs/tree/main)
[](https://app.travis-ci.com/defstream/kickable-rs)
[](https://coveralls.io/github/defstream/kickable-rs?branch=main)
[](https://codecov.io/gh/defstream/kickable-rs)
[](https://readthedocs.org/projects/kickable-rs)
[](https://bestpractices.coreinfrastructure.org/projects/7146)
# kickable
**kickable** is a crate created to answer the age old question... "_Can I Kick It?_"
_This package is for showcase purposes only._
**What is a kickable?**
Currently only the word "it" is kickable.
## Library
### Install
Use the kickable library in your project by adding it to your Cargo.toml file.
```shell
$ cargo add kickable
```
### Usage
```rust
use kickable;
fn main() {
let kickable = kickable::validate("it");
println!("Can you kick it? {kickable}");
}
```
## CLI
### Install
Download the binary from the releases page and place it in your path, or if you have cargo installed.
```bash
$ cargo install kickable
```
### Usage
Obtain help about the kickable cli.
```shell
$ kickable --help
kickable is a crate created to answer the age old question... Can I kick it?
Usage: kickable [OPTIONS]
Arguments:
The item to check for kick-ability
Options:
-c, --config The path to the configuration file [default: kickable.yaml]
-h, --help Print help
-V, --version Print version
```
An example of the most basic usage of the kickable cli.
```shell
$ kickable "it"
Yes, yes you can.
```
### Configuration
Below is an example of an optional kickable configuration file.
```yaml
# items that are kickable
items:
- it # English
- Êl # Spanish
- el # Spanish
- ãã # Japanese
- il # French
# language preferred for i18n messages
lang: en-US # default language
# logging configuration
logging:
level: 1 # 1: debug, 2: info, 3: warning, 4: error, 5: critical
file: /var/log/kickable # log file path
# server configuration
server:
addr: 0.0.0.0 # address to bind to
port: 8080 # port number
# client configuration
client:
addr: 0.0.0.0 # address to connect to
port: 8080 # port number
```
## Maintainers
Hector Gray (@defstream)
## Contribute
Pull Requests welcome. Please make sure all tests pass đ
## License
Kickable by Hector Gray is marked with CC0 1.0 Universal. To view a copy of this license, visit http://creativecommons.org/publicdomain/zero/1.0
[](http://creativecommons.org/publicdomain/zero/1.0kickable)