forked from arduino/arduino-cli
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of github.com:bcmi-labs/arduino-cli into lib-fe…
…atures
- Loading branch information
Showing
18 changed files
with
1,019 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,5 @@ | ||
= arduino-cli | ||
Alessandro Sanino <a[email protected]> | ||
|
||
Arduino CLI is a tool to access all Arduino Create API from Command Line. | ||
It implements all functions provided by web version of Arduino Create. | ||
|
@@ -9,10 +10,10 @@ It implements all functions provided by web version of Arduino Create. | |
. Reload shell configuration or reboot | ||
And you're done, now let's see how to use the CLI. | ||
|
||
== Usage | ||
== Usage : An example | ||
|
||
A general call is `arduino [COMMAND] [options]` | ||
To see the full list of commands, call `arduino -h` or `arduino --help` | ||
To see the full list of commands, call `arduino help [COMMAND]`, arduino [COMMAND] -h` or `arduino [COMMAND] --help` | ||
|
||
== Contribution | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
|
||
#!/bin/bash | ||
|
||
# This file is part of arduino-cli. | ||
# | ||
# arduino-cli is free software; you can redistribute it and/or modify | ||
# it under the terms of the GNU General Public License as published by | ||
# the Free Software Foundation; either version 2 of the License, or | ||
# (at your option) any later version. | ||
# | ||
# This program is distributed in the hope that it will be useful, | ||
# but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
# GNU General Public License for more details. | ||
# | ||
# You should have received a copy of the GNU General Public License | ||
# along with this program; if not, write to the Free Software | ||
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | ||
# | ||
# As a special exception, you may use this file as part of a free software | ||
# library without restriction. Specifically, if other files instantiate | ||
# templates or use macros or inline functions from this file, or you compile | ||
# this file and link it with other files to produce an executable, this | ||
# file does not by itself cause the resulting executable to be covered by | ||
# the GNU General Public License. This exception does not however | ||
# invalidate any other reasons why the executable file might be covered by | ||
# the GNU General Public License. | ||
# | ||
# Copyright 2017 BCMI LABS SA (http://www.arduino.cc/) | ||
|
||
#Arduino CLI install script | ||
#Assumes installation from folder cloned from github | ||
#e.g `git clone CLI_REPO && ./CLI_REPO/dist/install.sh` | ||
#TODO |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
= Bash Autocompletion | ||
Alessandro Sanino <a[email protected]> | ||
|
||
File contained in this directory is the file to allow autocompletion of the arduino CLI commands | ||
|
||
== Installation | ||
. Move the file (using `sudo`) to directory `/etc/bash_completion.d` | ||
[source, bash] | ||
---- | ||
sudo mv $PROJECT_DIR/docs/bash_completion/arduino /etc/bash_completion.d/ | ||
---- | ||
|
||
. Reload bash completion configuration : | ||
[source, bash] | ||
---- | ||
source /etc/bash_completion | ||
. /etc/bash_completion.d/arduino | ||
---- | ||
|
||
. Requires `$PROJECT_DIR` in `PATH` environment variable | ||
[source, bash] | ||
---- | ||
export PATH=$PATH:$PROJECT_DIR | ||
---- | ||
|
||
== How has been autocompletion obtained? | ||
It has been obtained by setting up the BashAutocompletionFunction field of Root Command | ||
|
||
``` | ||
|
||
``` |
Oops, something went wrong.