The StrixEye CLI

Get the most out of your StrixEye experience
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Authentication
   • Installation
3. Usage
   • Agent Installation
4. Downloads
5. Roadmap
6. Contributing
7. License
8. Contact
9. Acknowledgements

About The Project

Built With

Thanks to maintainers and communities of the following projects for making development of our CLI easier. Full list of dependencies can be found in go modules file.

• Cobra
• Viper

Getting Started

General information about setting up StrixEye CLI locally

Prerequisites

Required software and installations.

• CLI has no external dependencies. It will work on all machines those operating systems we support.

Authentication

There are 3 ways you can authenticate yourself to StrixEye Cloud servers.

via CLI

strixeye configure user

or

strixeye login

Then, enter your User API Token when prompted.

via flags

   strixeye configure user --user-api-token=<YOUR_TOKEN> --agent-id=<YOUR_AGENT_ID>

via config file

Check out documentation to see possible places for StrixEye CLI. On *NIX, it is under /etc/strixeye-cli/cli.json

Edit/Add user_api_token and agent_id fields in your cli config file

user_api_token: YOUR_USER_API_TOKEN
agent_id: SELECTED_AGENT_ID

Installation

1. Download StrixEye CLI for your Operating System and Distribution from here or build from source

2. Register or contact StrixEye

3. Get your User API Key from StrixEye Dashboard

4. Get StrixEye CLI from your package manager or see Build

5. Authenticate yourself to StrixEye

6. Choose an agent to work with:

   strixeye configure agent

   

Usage

For more examples, please refer to the Documentation

Installing Agent

After you have authenticated and selected an agent, you can simply install the agent via:

   $ strixeye agent install

If you are not sure about your configuration, you can ask for an interactive installation process

   $ strixeye agent install --interactive

Build

Other than Go version 1.16.+, StrixEye CLI has no dependencies/requirements.

Basic building process like the following would suffice.

   $ go build -o strixeye cmd/strixeye/main.go

Downloads

Tarball

1. Download latest-release for your operating system/architecture
2. Unzip binary and place it somewhere in your path
3. Make it executable

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learned, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the Apache License 2.0 License. See LICENSE for more information.

Contact

StrixEye - @strixeye - [email protected]

Project Link: https://github.com/strixeyecom/cli