Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
evoggy committed Sep 6, 2024
1 parent 15fef91 commit e302782
Showing 1 changed file with 27 additions and 22 deletions.
49 changes: 27 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,24 @@
# Crazyflie CLI

This is a command line interface (CLI) for the Crazyflie 2.X written in Rust. It's intended to be used
This is a command line interface (CLI) for the Bitcraze Crazyflie written in Rust. It's intended to be used
during development to easily log the console, set parameters and get logging variables. It's not
intended to be used from any scripts to make the Crazyflie do things, then using the
[Crazyflie python library](https://github.com/bitcraze/crazyflie-lib-python) is preferred.

## Installation

If you would like to install the CLI, you can do so by running the following command:
If you would like to install the cli for general use use the following command:

```text
git clone https://github.com/evoggy/cf-cli.git
cargo install --path cf-cli
```

Now the `cfcli` command should be available in your terminal.

Or if you would like to run it from source use the following command:

```text
git clone https://github.com/evoggy/cf-cli.git
cd cf-cli
cargo run -- <args>
```

For example:

```text
cargo run -- select
cargo install cfcli
```

## Usage

To see how to use the CLI type ```cfcli``` in your terminal and you will get the following help message:

```text
Crazyflie CLI
Crazyflie command-line client
Usage: cfcli [OPTIONS] <COMMAND>
Expand All @@ -53,13 +36,19 @@ Options:
-V, --version Print version
```

To use the CLI you must first select which URI to use, this is done by scanning for available Crazyflies
To use the CLI you must first select which URI to use, this is done by scanning for available Crazyflies
and selecting the one you prefer.

```text
cfcli select
```

If you have a Crazyflie on a different address than the default you can specify it using the `-a` flag:

```text
cfcli -a E7E7E7E7E7 select
```

Now this URI will be used in all commands until a new one is selected. For instance a parameter
can be set using the following command:

Expand All @@ -71,5 +60,21 @@ And a log variable can be printed using the following command:

```text
cfcli log print stabilizer.roll 100
```


## Development

If you would like to run it from source use the following command:

```text
git clone https://github.com/evoggy/cfcli.git
cd cfcli
cargo run -- <args>
```

For example:

```text
cargo run -- select
```

0 comments on commit e302782

Please sign in to comment.