Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/liuchong/cargo-x

A very simple third-party cargo subcommand to execute a custom command
https://github.com/liuchong/cargo-x

cargo party-cargo-subcommand rust rust-crate rust-lang rustlang

Last synced: 27 days ago
JSON representation

A very simple third-party cargo subcommand to execute a custom command

Awesome Lists containing this project

README

        

cargo-x
=======

[![Build Status](https://github.com/liuchong/cargo-x/actions/workflows/rust.yml/badge.svg)](https://github.com/liuchong/cargo-x/actions/workflows/rust.yml)
[![APACHE licensed](https://img.shields.io/badge/license-apache%202.0-blue.svg)](./LICENSE-APACHE)
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE-MIT)
[![crates.io](https://img.shields.io/crates/v/cargo-x.svg)](https://crates.io/crates/cargo-x)
[![Released API docs](https://docs.rs/cargo-x/badge.svg)](https://docs.rs/cargo-x)

A very simple third-party cargo subcommand to execute a custom command

## Usage

1. install cargo-x

```
cargo install cargo-x
```

or upgrade

```
cargo install -f cargo-x
```

2. write a config file `x.toml` in `"name = detail"` format like

```
ls = "ls -ltr"
```

or same lines in file `~/.x.toml`,

or in `[package.metadata.x]` section in `Cargo.toml` file.

***note*** that `DO NOT` use key x like `x = "any command"`, `cargo-x x` will run into problem,
because it does not know if it is using `cargo-x x` or `cargo x`.

3. use cargo-x

```
cargo x ls
# or
cargo-x ls
# or
x ls
```

## License

Licensed under either of these:

* Apache License Version 2.0 [LICENSE-APACHE](LICENSE-APACHE)
* MIT License [LICENSE-MIT](LICENSE-MIT)

### Contributing

Please sign a cla, thanks!