Skip to content

Commit e4966d0

Browse files
Massimiliano Pippimasci
Massimiliano Pippi
authored andcommitted
add first draft of docs
1 parent 8fd2b26 commit e4966d0

37 files changed

+1924
-0
lines changed

docs/commands/arduino-cli.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
## arduino-cli
2+
3+
Arduino CLI.
4+
5+
### Synopsis
6+
7+
Arduino Command Line Interface (arduino-cli).
8+
9+
### Examples
10+
11+
```
12+
arduino-cli <command> [flags...]
13+
```
14+
15+
### Options
16+
17+
```
18+
--additional-urls strings Additional URLs for the board manager.
19+
--config-file string The custom config file (if not specified the default will be used).
20+
--format string The output format, can be [text|json]. (default "text")
21+
-h, --help help for arduino-cli
22+
--log-file string Path to the file where logs will be written.
23+
--log-format string The output format for the logs, can be [text|json].
24+
--log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic
25+
-v, --verbose Print the logs on the standard output.
26+
```
27+
28+
### SEE ALSO
29+
30+
* [arduino-cli board](arduino-cli_board.md) - Arduino board commands.
31+
* [arduino-cli cache](arduino-cli_cache.md) - Arduino cache commands.
32+
* [arduino-cli compile](arduino-cli_compile.md) - Compiles Arduino sketches.
33+
* [arduino-cli config](arduino-cli_config.md) - Arduino Configuration Commands.
34+
* [arduino-cli core](arduino-cli_core.md) - Arduino Core operations.
35+
* [arduino-cli daemon](arduino-cli_daemon.md) - Run as a daemon on port
36+
* [arduino-cli debug](arduino-cli_debug.md) - Debug Arduino sketches.
37+
* [arduino-cli lib](arduino-cli_lib.md) - Arduino commands about libraries.
38+
* [arduino-cli sketch](arduino-cli_sketch.md) - Arduino CLI Sketch Commands.
39+
* [arduino-cli upload](arduino-cli_upload.md) - Upload Arduino sketches.
40+
* [arduino-cli version](arduino-cli_version.md) - Shows version number of arduino CLI.
41+
42+
###### Auto generated by spf13/cobra on 4-Mar-2020

docs/commands/arduino-cli_board.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
## arduino-cli board
2+
3+
Arduino board commands.
4+
5+
### Synopsis
6+
7+
Arduino board commands.
8+
9+
### Examples
10+
11+
```
12+
# Lists all connected boards.
13+
arduino-cli board list
14+
15+
# Attaches a sketch to a board.
16+
arduino-cli board attach serial:///dev/tty/ACM0 mySketch
17+
```
18+
19+
### Options
20+
21+
```
22+
-h, --help help for board
23+
```
24+
25+
### Options inherited from parent commands
26+
27+
```
28+
--additional-urls strings Additional URLs for the board manager.
29+
--config-file string The custom config file (if not specified the default will be used).
30+
--format string The output format, can be [text|json]. (default "text")
31+
--log-file string Path to the file where logs will be written.
32+
--log-format string The output format for the logs, can be [text|json].
33+
--log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic
34+
-v, --verbose Print the logs on the standard output.
35+
```
36+
37+
### SEE ALSO
38+
39+
* [arduino-cli](arduino-cli.md) - Arduino CLI.
40+
* [arduino-cli board attach](arduino-cli_board_attach.md) - Attaches a sketch to a board.
41+
* [arduino-cli board details](arduino-cli_board_details.md) - Print details about a board.
42+
* [arduino-cli board list](arduino-cli_board_list.md) - List connected boards.
43+
* [arduino-cli board listall](arduino-cli_board_listall.md) - List all known boards and their corresponding FQBN.
44+
45+
###### Auto generated by spf13/cobra on 4-Mar-2020
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## arduino-cli board attach
2+
3+
Attaches a sketch to a board.
4+
5+
### Synopsis
6+
7+
Attaches a sketch to a board.
8+
9+
```
10+
arduino-cli board attach <port>|<FQBN> [sketchPath] [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
arduino-cli board attach serial:///dev/tty/ACM0
17+
arduino-cli board attach serial:///dev/tty/ACM0 HelloWorld
18+
arduino-cli board attach arduino:samd:mkr1000
19+
```
20+
21+
### Options
22+
23+
```
24+
-h, --help help for attach
25+
--timeout string The timeout of the search of connected devices, try to high it if your board is not found (e.g. to 10s). (default "5s")
26+
```
27+
28+
### Options inherited from parent commands
29+
30+
```
31+
--additional-urls strings Additional URLs for the board manager.
32+
--config-file string The custom config file (if not specified the default will be used).
33+
--format string The output format, can be [text|json]. (default "text")
34+
--log-file string Path to the file where logs will be written.
35+
--log-format string The output format for the logs, can be [text|json].
36+
--log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic
37+
-v, --verbose Print the logs on the standard output.
38+
```
39+
40+
### SEE ALSO
41+
42+
* [arduino-cli board](arduino-cli_board.md) - Arduino board commands.
43+
44+
###### Auto generated by spf13/cobra on 4-Mar-2020
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## arduino-cli board details
2+
3+
Print details about a board.
4+
5+
### Synopsis
6+
7+
Show information about a board, in particular if the board has options to be specified in the FQBN.
8+
9+
```
10+
arduino-cli board details <FQBN> [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
arduino-cli board details arduino:avr:nano
17+
```
18+
19+
### Options
20+
21+
```
22+
-h, --help help for details
23+
```
24+
25+
### Options inherited from parent commands
26+
27+
```
28+
--additional-urls strings Additional URLs for the board manager.
29+
--config-file string The custom config file (if not specified the default will be used).
30+
--format string The output format, can be [text|json]. (default "text")
31+
--log-file string Path to the file where logs will be written.
32+
--log-format string The output format for the logs, can be [text|json].
33+
--log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic
34+
-v, --verbose Print the logs on the standard output.
35+
```
36+
37+
### SEE ALSO
38+
39+
* [arduino-cli board](arduino-cli_board.md) - Arduino board commands.
40+
41+
###### Auto generated by spf13/cobra on 4-Mar-2020
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
## arduino-cli board list
2+
3+
List connected boards.
4+
5+
### Synopsis
6+
7+
Detects and displays a list of connected boards to the current computer.
8+
9+
```
10+
arduino-cli board list [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
arduino-cli board list --timeout 10s
17+
```
18+
19+
### Options
20+
21+
```
22+
-h, --help help for list
23+
--timeout string The timeout of the search of connected devices, try to increase it if your board is not found (e.g. to 10s). (default "0s")
24+
```
25+
26+
### Options inherited from parent commands
27+
28+
```
29+
--additional-urls strings Additional URLs for the board manager.
30+
--config-file string The custom config file (if not specified the default will be used).
31+
--format string The output format, can be [text|json]. (default "text")
32+
--log-file string Path to the file where logs will be written.
33+
--log-format string The output format for the logs, can be [text|json].
34+
--log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic
35+
-v, --verbose Print the logs on the standard output.
36+
```
37+
38+
### SEE ALSO
39+
40+
* [arduino-cli board](arduino-cli_board.md) - Arduino board commands.
41+
42+
###### Auto generated by spf13/cobra on 4-Mar-2020
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## arduino-cli board listall
2+
3+
List all known boards and their corresponding FQBN.
4+
5+
### Synopsis
6+
7+
List all boards that have the support platform installed. You can search
8+
for a specific board if you specify the board name
9+
10+
```
11+
arduino-cli board listall [boardname] [flags]
12+
```
13+
14+
### Examples
15+
16+
```
17+
arduino-cli board listall
18+
arduino-cli board listall zero
19+
```
20+
21+
### Options
22+
23+
```
24+
-h, --help help for listall
25+
```
26+
27+
### Options inherited from parent commands
28+
29+
```
30+
--additional-urls strings Additional URLs for the board manager.
31+
--config-file string The custom config file (if not specified the default will be used).
32+
--format string The output format, can be [text|json]. (default "text")
33+
--log-file string Path to the file where logs will be written.
34+
--log-format string The output format for the logs, can be [text|json].
35+
--log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic
36+
-v, --verbose Print the logs on the standard output.
37+
```
38+
39+
### SEE ALSO
40+
41+
* [arduino-cli board](arduino-cli_board.md) - Arduino board commands.
42+
43+
###### Auto generated by spf13/cobra on 4-Mar-2020

docs/commands/arduino-cli_cache.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## arduino-cli cache
2+
3+
Arduino cache commands.
4+
5+
### Synopsis
6+
7+
Arduino cache commands.
8+
9+
### Examples
10+
11+
```
12+
# Clean caches.
13+
arduino-cli cache clean
14+
15+
16+
```
17+
18+
### Options
19+
20+
```
21+
-h, --help help for cache
22+
```
23+
24+
### Options inherited from parent commands
25+
26+
```
27+
--additional-urls strings Additional URLs for the board manager.
28+
--config-file string The custom config file (if not specified the default will be used).
29+
--format string The output format, can be [text|json]. (default "text")
30+
--log-file string Path to the file where logs will be written.
31+
--log-format string The output format for the logs, can be [text|json].
32+
--log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic
33+
-v, --verbose Print the logs on the standard output.
34+
```
35+
36+
### SEE ALSO
37+
38+
* [arduino-cli](arduino-cli.md) - Arduino CLI.
39+
* [arduino-cli cache clean](arduino-cli_cache_clean.md) - Clean arduino cache.
40+
41+
###### Auto generated by spf13/cobra on 4-Mar-2020
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## arduino-cli cache clean
2+
3+
Clean arduino cache.
4+
5+
### Synopsis
6+
7+
Clean the files i.e. `~/arduino15/staging` in Linux.
8+
9+
```
10+
arduino-cli cache clean [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
arduino-cli cache clean
17+
```
18+
19+
### Options
20+
21+
```
22+
-h, --help help for clean
23+
```
24+
25+
### Options inherited from parent commands
26+
27+
```
28+
--additional-urls strings Additional URLs for the board manager.
29+
--config-file string The custom config file (if not specified the default will be used).
30+
--format string The output format, can be [text|json]. (default "text")
31+
--log-file string Path to the file where logs will be written.
32+
--log-format string The output format for the logs, can be [text|json].
33+
--log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic
34+
-v, --verbose Print the logs on the standard output.
35+
```
36+
37+
### SEE ALSO
38+
39+
* [arduino-cli cache](arduino-cli_cache.md) - Arduino cache commands.
40+
41+
###### Auto generated by spf13/cobra on 4-Mar-2020

0 commit comments

Comments
 (0)