command-line interface (CLI) for rerobots
Documentation of the current release is at https://rerobots-cli.readthedocs.io/ or can be built from sources as described below.
Most interesting interactions with rerobots require an API token, which can be
provided through the environment variable REROBOTS_API_TOKEN or via the
command-line switch -t. Get API tokens at https://rerobots.net/tokens
A Git LFS client is required to clone this
repository. Note that git clone will succeed without git lfs available, but
some large files will not be fetched.
This tool is implemented in Rust. To build, clone the repository at https://github.com/rerobots/cli.git and
cargo build
To perform tests,
cargo test
To check code style,
cargo +nightly fmt -- --check
cargo clippy --tests -- -D clippy::all
Building the User's Guide requires Sphinx, which can be installed by
cd doc
pip install -r requirements.txt
Now, in the doc/ directory,
make
The result is in build/. Start reading at build/index.html
All participation must follow our code of conduct, elaborated in the file CODEOFCONDUCT.md in the same directory as this README.
Please first check for prior reports that are similar or related in the issue tracker at https://github.com/rerobots/cli/issues
Reports of security flaws are given the highest priority and should be sent to security@rerobots.net, optionally encrypted with the public key available at https://rerobots.net/contact Please do so before opening a public issue to allow us an opportunity to find a fix.
Contributions are welcome! There is no formal declaration of code style. Just try to follow the style and structure currently in the repository.
Contributors, who are not rerobots employees, must agree to the Developer
Certificate of Origin. Your agreement is
indicated explicitly in commits by adding a Signed-off-by line with your real
name. (This can be done automatically using git commit --signoff.)
This is free software, released under the Apache License, Version 2.0. You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.