farmhub-cli

command module
v1.5.22 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 2, 2024 License: GPL-3.0 Imports: 2 Imported by: 0

README

FarmHub CLI

Version Test GPLv3 License

Handling your IoT devices and data with ease.

Getting Started

Login to your FarmHub account
farmhub login
Generating the code for your device

Once you have a project on your FarmHub dashboard, just run this command to walk through a sensor setup process with code generation

farmhub generate -o sketch.ino
Putting code on your device

Once you have the code from the previous command you can run this command to put it on the device.

farmhub flash <pathtosketch>

# Example if you used the above generate command
farmhub flash sketch.ino
Calibrating a device

You can interact with your device by running:

farmhub monitor

It will connect to your device via a serial monitor where you can run commands.

Installing

Homebrew

Installing on a Mac with homebrew:

brew tap farmhub/famrhub-cli https://github.com/thefarmhub/farmhub-cli
brew install farmhub
Scoop

Installing on a windows machine with scoop:

scoop bucket add farmhub-cli https://github.com/thefarmhub/farmhub-cli
scoop install farmhub
Manual Download

If you're not using a package manager you can just download the binary from our releases page or use the script below to automatically download it per your operating system requirements.

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/thefarmhub/farmhub-cli/main/download.sh)"

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd
internal
arduino/cli/feedback
Package feedback provides an uniform API that can be used to print feedback to the users in different formats.
Package feedback provides an uniform API that can be used to print feedback to the users in different formats.
kit

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL