From 8fd2b26ba2aeaae5987b32ad1f1aae961c321807 Mon Sep 17 00:00:00 2001 From: Massimiliano Pippi Date: Wed, 4 Mar 2020 16:27:31 +0100 Subject: [PATCH 01/15] added command reference generator --- .gitignore | 4 + docsgen/Taskfile.yml | 12 ++ docsgen/go.mod | 8 ++ docsgen/go.sum | 258 +++++++++++++++++++++++++++++++++++++++++++ docsgen/main.go | 36 ++++++ 5 files changed, 318 insertions(+) create mode 100644 docsgen/Taskfile.yml create mode 100644 docsgen/go.mod create mode 100644 docsgen/go.sum create mode 100644 docsgen/main.go diff --git a/.gitignore b/.gitignore index 935d14fe465..eea1db7b0be 100644 --- a/.gitignore +++ b/.gitignore @@ -20,3 +20,7 @@ venv # Misc. .DS_Store + +# Mkdocs +/public/ +/docsgen/arduino-cli \ No newline at end of file diff --git a/docsgen/Taskfile.yml b/docsgen/Taskfile.yml new file mode 100644 index 00000000000..9a2fd74ccd7 --- /dev/null +++ b/docsgen/Taskfile.yml @@ -0,0 +1,12 @@ +version: '2' + +tasks: + gen:commands: + desc: Generate commands reference + cmds: + # docs will generate examples using os.Args[0] so we need to call + # the generator `arduino-cli` + - go build -o arduino-cli + # we invoke `arduino-cli` like this instead of `./arduino-cli` to remove + # the `./` chars from the examples + - PATH=. arduino-cli ../docs/commands diff --git a/docsgen/go.mod b/docsgen/go.mod new file mode 100644 index 00000000000..85ce4dd6dc2 --- /dev/null +++ b/docsgen/go.mod @@ -0,0 +1,8 @@ +module github.com/arduino/arduino-cli/docsgen + +go 1.13 + +require ( + github.com/arduino/arduino-cli v0.0.0-20200228161349-4b874a02b096 + github.com/spf13/cobra v0.0.6 +) diff --git a/docsgen/go.sum b/docsgen/go.sum new file mode 100644 index 00000000000..93cef4e9078 --- /dev/null +++ b/docsgen/go.sum @@ -0,0 +1,258 @@ +bou.ke/monkey v1.0.1/go.mod h1:FgHuK96Rv2Nlf+0u1OOVDpCMdsWyOFmeeketDHE7LIg= +cloud.google.com/go v0.26.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw= +github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU= +github.com/OneOfOne/xxhash v1.2.2/go.mod h1:HSdplMjZKSmBqAxg5vPj2TmRDmfkzw+cTzAElWljhcU= +github.com/alecthomas/template v0.0.0-20160405071501-a0175ee3bccc/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc= +github.com/alecthomas/units v0.0.0-20151022065526-2efee857e7cf/go.mod h1:ybxpYRFXyAe+OPACYpWeL0wqObRcbAqCMya13uyzqw0= +github.com/arduino/arduino-cli v0.0.0-20200228161349-4b874a02b096 h1:pRCuLflPeF1VUu4XMZvdOL4Gm89tTid5BytkwlAowZA= +github.com/arduino/arduino-cli v0.0.0-20200228161349-4b874a02b096/go.mod h1:+5mvmvT+f7sKtM9yOYBbKgmu55ENXCEPFtijdFaLdWs= +github.com/arduino/board-discovery v0.0.0-20180823133458-1ba29327fb0c h1:agh2JT96G8egU7FEb13L4dq3fnCN7lxXhJ86t69+W7s= +github.com/arduino/board-discovery v0.0.0-20180823133458-1ba29327fb0c/go.mod h1:HK7SpkEax/3P+0w78iRQx1sz1vCDYYw9RXwHjQTB5i8= +github.com/arduino/go-paths-helper v1.0.1 h1:utYXLM2RfFlc9qp/MJTIYp3t6ux/xM6mWjeEb/WLK4Q= +github.com/arduino/go-paths-helper v1.0.1/go.mod h1:HpxtKph+g238EJHq4geEPv9p+gl3v5YYu35Yb+w31Ck= +github.com/arduino/go-properties-orderedmap v0.0.0-20190828172252-05018b28ff6c h1:4z4PJqNH8WGXtm9ix2muUOAP7gxTGBOdQTuKEDyCnsA= +github.com/arduino/go-properties-orderedmap v0.0.0-20190828172252-05018b28ff6c/go.mod h1:kiSuHm7yz3chiy8rb2MphC7ECn3MlkQFAIe4SXmQg6o= +github.com/arduino/go-timeutils v0.0.0-20171220113728-d1dd9e313b1b h1:9hDi4F2st6dbLC3y4i02zFT5quS4X6iioWifGlVwfy4= +github.com/arduino/go-timeutils v0.0.0-20171220113728-d1dd9e313b1b/go.mod h1:uwGy5PpN4lqW97FiLnbcx+xx8jly5YuPMJWfVwwjJiQ= +github.com/arduino/go-win32-utils v0.0.0-20180330194947-ed041402e83b h1:3PjgYG5gVPA7cipp7vIR2lF96KkEJIFBJ+ANnuv6J20= +github.com/arduino/go-win32-utils v0.0.0-20180330194947-ed041402e83b/go.mod h1:iIPnclBMYm1g32Q5kXoqng4jLhMStReIP7ZxaoUC2y8= +github.com/armon/consul-api v0.0.0-20180202201655-eb2c6b5be1b6/go.mod h1:grANhF5doyWs3UAsr3K4I6qtAmlQcZDesFNEHPZAzj8= +github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24TaqPxmxbtue+5NUziq4I4S80YR8gNf3Q= +github.com/beorn7/perks v1.0.0/go.mod h1:KWe93zE9D1o94FZ5RNwFwVgaQK1VOXiVxmqh+CedLV8= +github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU= +github.com/cespare/xxhash v1.1.0/go.mod h1:XrSqR1VqqWfGrhpAt58auRo0WTKS1nRRg3ghfAqPWnc= +github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw= +github.com/cmaglie/pb v1.0.27 h1:ynGj8vBXR+dtj4B7Q/W/qGt31771Ux5iFfRQBnwdQiA= +github.com/cmaglie/pb v1.0.27/go.mod h1:GilkKZMXYjBA4NxItWFfO+lwkp59PLHQ+IOW/b/kmZI= +github.com/codeclysm/cc v1.2.2 h1:1ChS4EvWTjw6bH2sd6QiMcmih0itVVrWdh9MmOliX/I= +github.com/codeclysm/cc v1.2.2/go.mod h1:XtW4ArCNgQwFphcRGG9+sPX5WM1J6/u0gMy5ZdV3obA= +github.com/codeclysm/extract v2.2.0+incompatible h1:q3wyckoA30bhUSiwdQezMqVhwd8+WGE64/GL//LtUhI= +github.com/codeclysm/extract v2.2.0+incompatible/go.mod h1:2nhFMPHiU9At61hz+12bfrlpXSUrOnK+wR+KlGO4Uks= +github.com/coreos/bbolt v1.3.2/go.mod h1:iRUV2dpdMOn7Bo10OQBFzIJO9kkE559Wcmn+qkEiiKk= +github.com/coreos/etcd v3.3.10+incompatible/go.mod h1:uF7uidLiAD3TWHmW31ZFd/JWoc32PjwdhPthX9715RE= +github.com/coreos/go-etcd v2.0.0+incompatible/go.mod h1:Jez6KQU2B/sWsbdaef3ED8NzMklzPG4d5KIOhIy30Tk= +github.com/coreos/go-semver v0.2.0/go.mod h1:nnelYz7RCh+5ahJtPPxZlU+153eP4D4r3EedlOD2RNk= +github.com/coreos/go-systemd v0.0.0-20190321100706-95778dfbb74e/go.mod h1:F5haX7vjVVG0kc13fIWeqUViNPyEJxv/OmvnBo0Yme4= +github.com/coreos/pkg v0.0.0-20180928190104-399ea9e2e55f/go.mod h1:E3G3o1h8I7cfcXa63jLwjI0eiQQMgzzUDFVpN/nH/eA= +github.com/cpuguy83/go-md2man v1.0.10 h1:BSKMNlYxDvnunlTymqtgONjNnaRV1sTpcovwwjF22jk= +github.com/cpuguy83/go-md2man v1.0.10/go.mod h1:SmD6nW6nTyfqj6ABTjUi3V3JVMnlJmwcJI5acqYI6dE= +github.com/cpuguy83/go-md2man/v2 v2.0.0 h1:EoUDS0afbrsXAZ9YQ9jdu/mZ2sXgT1/2yyNng4PGlyM= +github.com/cpuguy83/go-md2man/v2 v2.0.0/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU= +github.com/creack/goselect v0.1.1 h1:tiSSgKE1eJtxs1h/VgGQWuXUP0YS4CDIFMp6vaI1ls0= +github.com/creack/goselect v0.1.1/go.mod h1:a/NhLweNvqIYMuxcMOuWY516Cimucms3DglDzQP3hKY= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/dgrijalva/jwt-go v3.2.0+incompatible/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ= +github.com/dgryski/go-sip13 v0.0.0-20181026042036-e10d5fee7954/go.mod h1:vAd38F8PWV+bWy6jNmig1y/TA+kYO4g3RSRF0IAv0no= +github.com/envoyproxy/go-control-plane v0.9.1-0.20191026205805-5f8ba28d4473/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4= +github.com/envoyproxy/protoc-gen-validate v0.1.0/go.mod h1:iSmxcyjqTsJpI2R4NaDN7+kN2VEUnK/pcBlmesArF7c= +github.com/fatih/color v1.7.0 h1:DkWD4oS2D8LGGgTQ6IvwJJXSL5Vp2ffcQg58nFV38Ys= +github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4= +github.com/fluxio/iohelpers v0.0.0-20160419043813-3a4dd67a94d2 h1:C6sOwknxwWfLBEQ91zhmptlfxf7pVEs5s6wOnDxNpS4= +github.com/fluxio/iohelpers v0.0.0-20160419043813-3a4dd67a94d2/go.mod h1:c7sGIpDbBo0JZZ1tKyC1p5smWf8QcUjK4bFtZjHAecg= +github.com/fluxio/multierror v0.0.0-20160419044231-9c68d39025e5 h1:R8jFW6G/bjoXjWPFrEfw9G5YQDlYhwV4AC+Eonu6wmk= +github.com/fluxio/multierror v0.0.0-20160419044231-9c68d39025e5/go.mod h1:BEUDl7FG1cc76sM0J0x8dqr6RhiL4uqvk6oFkwuNyuM= +github.com/fsnotify/fsnotify v1.4.7 h1:IXs+QLmnXW2CcXuY+8Mzv/fWEsPGWxqefPtCP5CnV9I= +github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo= +github.com/ghodss/yaml v1.0.0/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04= +github.com/go-errors/errors v1.0.1 h1:LUHzmkK3GUKUrL/1gfBUxAHzcev3apQlezX/+O7ma6w= +github.com/go-errors/errors v1.0.1/go.mod h1:f4zRHt4oKfwPJE5k8C9vpYG+aDHdBFUsgrm6/TyX73Q= +github.com/go-kit/kit v0.8.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2as= +github.com/go-logfmt/logfmt v0.3.0/go.mod h1:Qt1PoO58o5twSAckw1HlFXLmHsOX5/0LbT9GBnD5lWE= +github.com/go-logfmt/logfmt v0.4.0/go.mod h1:3RMwSq7FuexP4Kalkev3ejPJsZTpXXBr9+V4qmtdjCk= +github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY= +github.com/gogo/protobuf v1.1.1/go.mod h1:r8qH/GZQm5c6nD/R0oafs1akxWv10x8SbQlK7atdtwQ= +github.com/gogo/protobuf v1.2.1/go.mod h1:hp+jE20tsWTFYpLwKvXlhS1hjn+gTNwPg2I6zVXpSg4= +github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q= +github.com/golang/groupcache v0.0.0-20190129154638-5b532d6fd5ef/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= +github.com/golang/mock v1.1.1/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A= +github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= +github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= +github.com/golang/protobuf v1.3.2/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= +github.com/golang/protobuf v1.3.3 h1:gyjaxf+svBWX08ZjK86iN9geUJF0H6gp2IRKX6Nf6/I= +github.com/golang/protobuf v1.3.3/go.mod h1:vzj43D7+SQXF/4pzW/hwtAqwc6iTitCiVSaWz5lYuqw= +github.com/google/btree v1.0.0/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ= +github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M= +github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1/go.mod h1:wJfORRmW1u3UXTncJ5qlYoELFm8eSnnEO6hX4iZ3EWY= +github.com/gorilla/websocket v1.4.0/go.mod h1:E7qHFY5m1UJ88s3WnNqhKjPHQ0heANvMoAMk2YaljkQ= +github.com/grpc-ecosystem/go-grpc-middleware v1.0.0/go.mod h1:FiyG127CGDf3tlThmgyCl78X/SZQqEOJBCDaAfeWzPs= +github.com/grpc-ecosystem/go-grpc-prometheus v1.2.0/go.mod h1:8NvIoxWQoOIhqOTXgfV/d3M/q6VIi02HzZEHgUlZvzk= +github.com/grpc-ecosystem/grpc-gateway v1.9.0/go.mod h1:vNeuVxBJEsws4ogUvrchl83t/GYV9WGTSLVdBhOQFDY= +github.com/h2non/filetype v1.0.8 h1:le8gpf+FQA0/DlDABbtisA1KiTS0Xi+YSC/E8yY3Y14= +github.com/h2non/filetype v1.0.8/go.mod h1:isekKqOuhMj+s/7r3rIeTErIRy4Rub5uBWHfvMusLMU= +github.com/hashicorp/hcl v1.0.0 h1:0Anlzjpi4vEasTeNFn2mLJgTSwt0+6sfsiTG8qcWGx4= +github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ= +github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8= +github.com/jonboulle/clockwork v0.1.0/go.mod h1:Ii8DK3G1RaLaWxj9trq07+26W01tbo22gdxWY5EU2bo= +github.com/jtolds/gls v4.20.0+incompatible/go.mod h1:QJZ7F/aHp+rZTRtaJ1ow/lLfFfVYBRgL+9YlvaHOwJU= +github.com/juju/errors v0.0.0-20181118221551-089d3ea4e4d5 h1:rhqTjzJlm7EbkELJDKMTU7udov+Se0xZkWmugr6zGok= +github.com/juju/errors v0.0.0-20181118221551-089d3ea4e4d5/go.mod h1:W54LbzXuIE0boCoNJfwqpmkKJ1O4TCTZMetAt6jGk7Q= +github.com/juju/loggo v0.0.0-20190526231331-6e530bcce5d8/go.mod h1:vgyd7OREkbtVEN/8IXZe5Ooef3LQePvuBm9UWj6ZL8U= +github.com/juju/testing v0.0.0-20190429233213-dfc56b8c09fc/go.mod h1:63prj8cnj0tU0S9OHjGJn+b1h0ZghCndfnbQolrYTwA= +github.com/julienschmidt/httprouter v1.2.0/go.mod h1:SYymIcj16QtmaHHD7aYtjjsJG7VTCxuUUipMqKk8s4w= +github.com/kisielk/errcheck v1.1.0/go.mod h1:EZBBE59ingxPouuu3KfxchcWSUPOHkagtvWXihfKN4Q= +github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck= +github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ= +github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515/go.mod h1:+0opPa2QZZtGFBFZlji/RkVcI2GknAs/DXo4wKdlNEc= +github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= +github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= +github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= +github.com/magiconair/properties v1.8.0 h1:LLgXmsheXeRoUOBOjtwPQCWIYqM/LU1ayDtDePerRcY= +github.com/magiconair/properties v1.8.0/go.mod h1:PppfXfuXeibc/6YijjN8zIbojt8czPbwD3XqdrwzmxQ= +github.com/mattn/go-colorable v0.1.2 h1:/bC9yWikZXAL9uJdulbSfyVNIR3n3trXl+v8+1sx8mU= +github.com/mattn/go-colorable v0.1.2/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVcfRqFIhoBtE= +github.com/mattn/go-isatty v0.0.8 h1:HLtExJ+uU2HOZ+wI0Tt5DtUDrx8yhUqDcp7fYERX4CE= +github.com/mattn/go-isatty v0.0.8/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s= +github.com/mattn/go-runewidth v0.0.2 h1:UnlwIPBGaTZfPQ6T1IGzPI0EkYAQmT9fAEJ/poFC63o= +github.com/mattn/go-runewidth v0.0.2/go.mod h1:LwmH8dsx7+W8Uxz3IHJYH5QSwggIsqBzpuz5H//U1FU= +github.com/matttproud/golang_protobuf_extensions v1.0.1/go.mod h1:D8He9yQNgCq6Z5Ld7szi9bcBfOoFv/3dc6xSMkL2PC0= +github.com/miekg/dns v1.0.5 h1:MQBGf2JEJDu0rg9WOpQZzeO+zW8UKwgkvP3R1dUU1Yw= +github.com/miekg/dns v1.0.5/go.mod h1:W1PPwlIAgtquWBMBEV9nkV9Cazfe8ScdGz/Lj7v3Nrg= +github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0= +github.com/mitchellh/mapstructure v1.1.2 h1:fmNYVwqnSfB9mZU6OS2O6GsXM+wcskZDuKQzvN1EDeE= +github.com/mitchellh/mapstructure v1.1.2/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y= +github.com/mwitkow/go-conntrack v0.0.0-20161129095857-cc309e4a2223/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U= +github.com/oklog/ulid v1.3.1/go.mod h1:CirwcVhetQ6Lv90oh/F+FBtV6XMibvdAFo93nm5qn4U= +github.com/oleksandr/bonjour v0.0.0-20160508152359-5dcf00d8b228 h1:Cvfd2dOlXIPTeEkOT/h8PyK4phBngOM4at9/jlgy7d4= +github.com/oleksandr/bonjour v0.0.0-20160508152359-5dcf00d8b228/go.mod h1:MGuVJ1+5TX1SCoO2Sx0eAnjpdRytYla2uC1YIZfkC9c= +github.com/pelletier/go-toml v1.2.0 h1:T5zMGML61Wp+FlcbWjRDT7yAxhJNAiPPLOFECq181zc= +github.com/pelletier/go-toml v1.2.0/go.mod h1:5z9KED0ma1S8pY6P1sdut58dfprrGBbd/94hg7ilaic= +github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I= +github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/pmylund/sortutil v0.0.0-20120526081524-abeda66eb583 h1:ogHi8YLNeIxABOaH6UgtbwkODheuAK+ErP8gWXYQVj0= +github.com/pmylund/sortutil v0.0.0-20120526081524-abeda66eb583/go.mod h1:sFPiU/UgDcsQVu3vkqpZLCXWFwUoQRpHGu9ATihPAl0= +github.com/prometheus/client_golang v0.9.1/go.mod h1:7SWBe2y4D6OKWSNQJUaRYU/AaXPKyh/dDVn+NZz0KFw= +github.com/prometheus/client_golang v0.9.3/go.mod h1:/TN21ttK/J9q6uSwhBd54HahCDft0ttaMvbicHlPoso= +github.com/prometheus/client_model v0.0.0-20180712105110-5c3871d89910/go.mod h1:MbSGuTsp3dbXC40dX6PRTWyKYBIrTGTE9sqQNg2J8bo= +github.com/prometheus/client_model v0.0.0-20190129233127-fd36f4220a90/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA= +github.com/prometheus/client_model v0.0.0-20190812154241-14fe0d1b01d4/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA= +github.com/prometheus/common v0.0.0-20181113130724-41aa239b4cce/go.mod h1:daVV7qP5qjZbuso7PdcryaAu0sAZbrN9i7WWcTMWvro= +github.com/prometheus/common v0.4.0/go.mod h1:TNfzLD0ON7rHzMJeJkieUDPYmFC7Snx/y86RQel1bk4= +github.com/prometheus/procfs v0.0.0-20181005140218-185b4288413d/go.mod h1:c3At6R/oaqEKCNdg8wHV1ftS6bRYblBhIjjI8uT2IGk= +github.com/prometheus/procfs v0.0.0-20190507164030-5867b95ac084/go.mod h1:TjEm7ze935MbeOT/UhFTIMYKhuLP4wbCsTZCD3I8kEA= +github.com/prometheus/tsdb v0.7.1/go.mod h1:qhTCs0VvXwvX/y3TZrWD7rabWM+ijKTux40TwIPHuXU= +github.com/rifflock/lfshook v0.0.0-20180920164130-b9218ef580f5 h1:mZHayPoR0lNmnHyvtYjDeq0zlVHn9K/ZXoy17ylucdo= +github.com/rifflock/lfshook v0.0.0-20180920164130-b9218ef580f5/go.mod h1:GEXHk5HgEKCvEIIrSpFI3ozzG5xOKA2DVlEX/gGnewM= +github.com/rogpeppe/fastuuid v0.0.0-20150106093220-6724a57986af/go.mod h1:XWv6SoW27p1b0cqNHllgS5HIMJraePCO15w5zCzIWYg= +github.com/russross/blackfriday v1.5.2 h1:HyvC0ARfnZBqnXwABFeSZHpKvJHJJfPz81GNueLj0oo= +github.com/russross/blackfriday v1.5.2/go.mod h1:JO/DiYxRf+HjHt06OyowR9PTA263kcR/rfWxYHBV53g= +github.com/russross/blackfriday/v2 v2.0.1 h1:lPqVAte+HuHNfhJ/0LC98ESWRz8afy9tM/0RK8m9o+Q= +github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= +github.com/schollz/closestmatch v2.1.0+incompatible h1:Uel2GXEpJqOWBrlyI+oY9LTiyyjYS17cCYRqP13/SHk= +github.com/schollz/closestmatch v2.1.0+incompatible/go.mod h1:RtP1ddjLong6gTkbtmuhtR2uUrrJOpYzYRvbcPAid+g= +github.com/shurcooL/sanitized_anchor_name v1.0.0 h1:PdmoCO6wvbs+7yrJyMORt4/BmY5IYyJwS/kOiWx8mHo= +github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc= +github.com/sirupsen/logrus v1.2.0/go.mod h1:LxeOpSwHxABJmUn/MG1IvRgCAasNZTLOkJPxbbu5VWo= +github.com/sirupsen/logrus v1.4.2 h1:SPIRibHv4MatM3XXNO2BJeFLZwZ2LvZgfQ5+UNI2im4= +github.com/sirupsen/logrus v1.4.2/go.mod h1:tLMulIdttU9McNUspp0xgXVQah82FyeX6MwdIuYE2rE= +github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d/go.mod h1:OnSkiWE9lh6wB0YB77sQom3nweQdgAjqCqsofrRNTgc= +github.com/smartystreets/goconvey v0.0.0-20190330032615-68dc04aab96a/go.mod h1:syvi0/a8iFYH4r/RixwvyeAJjdLS9QV7WQ/tjFTllLA= +github.com/soheilhy/cmux v0.1.4/go.mod h1:IM3LyeVVIOuxMH7sFAkER9+bJ4dT7Ms6E4xg4kGIyLM= +github.com/spaolacci/murmur3 v0.0.0-20180118202830-f09979ecbc72/go.mod h1:JwIasOWyU6f++ZhiEuf87xNszmSA2myDM2Kzu9HwQUA= +github.com/spf13/afero v1.1.2 h1:m8/z1t7/fwjysjQRYbP0RD+bUIF/8tJwPdEZsI83ACI= +github.com/spf13/afero v1.1.2/go.mod h1:j4pytiNVoe2o6bmDsKpLACNPDBIoEAkihy7loJ1B0CQ= +github.com/spf13/cast v1.3.0 h1:oget//CVOEoFewqQxwr0Ej5yjygnqGkvggSE/gB35Q8= +github.com/spf13/cast v1.3.0/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE= +github.com/spf13/cobra v0.0.5/go.mod h1:3K3wKZymM7VvHMDS9+Akkh4K60UwM26emMESw8tLCHU= +github.com/spf13/cobra v0.0.6 h1:breEStsVwemnKh2/s6gMvSdMEkwW0sK8vGStnlVBMCs= +github.com/spf13/cobra v0.0.6/go.mod h1:/6GTrnGXV9HjY+aR4k0oJ5tcvakLuG6EuKReYlHNrgE= +github.com/spf13/jwalterweatherman v1.0.0 h1:XHEdyB+EcvlqZamSM4ZOMGlc93t6AcsBEu9Gc1vn7yk= +github.com/spf13/jwalterweatherman v1.0.0/go.mod h1:cQK4TGJAtQXfYWX+Ddv3mKDzgVb68N+wFjFa4jdeBTo= +github.com/spf13/pflag v1.0.3 h1:zPAT6CGy6wXeQ7NtTnaTerfKOsV6V6F8agHXFiazDkg= +github.com/spf13/pflag v1.0.3/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4= +github.com/spf13/viper v1.3.2/go.mod h1:ZiWeW+zYFKm7srdB9IoDzzZXaJaI5eL9QjNiN/DMA2s= +github.com/spf13/viper v1.4.0 h1:yXHLWeravcrgGyFSyCgdYpXQ9dR9c/WED3pg1RhxqEU= +github.com/spf13/viper v1.4.0/go.mod h1:PTJ7Z/lr49W6bUbkmS1V3by4uWynFiR9p7+dSq/yZzE= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= +github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= +github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= +github.com/tmc/grpc-websocket-proxy v0.0.0-20190109142713-0ad062ec5ee5/go.mod h1:ncp9v5uamzpCO7NfCPTXjqaC+bZgJeR0sMTm6dMHP7U= +github.com/ugorji/go v1.1.4/go.mod h1:uQMGLiO92mf5W77hV/PUCpI3pbzQx3CRekS0kk+RGrc= +github.com/ugorji/go/codec v0.0.0-20181204163529-d75b2dcb6bc8/go.mod h1:VFNgLljTbGfSG7qAOspJ7OScBnGdDN/yBr0sguwnwf0= +github.com/xiang90/probing v0.0.0-20190116061207-43a291ad63a2/go.mod h1:UETIi67q53MR2AWcXfiuqkDkRtnGDLqkBTpCHuJHxtU= +github.com/xordataexchange/crypt v0.0.3-0.20170626215501-b2862e3d0a77/go.mod h1:aYKd//L2LvnjZzWKhF00oedf4jCCReLcmhLdhm1A27Q= +go.bug.st/cleanup v1.0.0 h1:XVj1HZxkBXeq3gMT7ijWUpHyIC1j8XAoNSyQ06CskgA= +go.bug.st/cleanup v1.0.0/go.mod h1:EqVmTg2IBk4znLbPD28xne3abjsJftMdqqJEjhn70bk= +go.bug.st/downloader v1.1.0 h1:LipC9rqRCe8kwa+ah3ZDfCqneVaf34cB/TKjXZiZt54= +go.bug.st/downloader v1.1.0/go.mod h1:l+RPbNbrTB+MoAIp8nrZsP22nRPDy26XJZQqmm4gNT4= +go.bug.st/relaxed-semver v0.0.0-20190922224835-391e10178d18 h1:F1qxtaFuewctYc/SsHRn+Q7Dtwi+yJGPgVq8YLtQz98= +go.bug.st/relaxed-semver v0.0.0-20190922224835-391e10178d18/go.mod h1:Cx1VqMtEhE9pIkEyUj3LVVVPkv89dgW8aCKrRPDR/uE= +go.bug.st/serial v1.0.0 h1:ogEPzrllCsnG00EqKRjeYvPRsO7NJW6DqykzkdD6E/k= +go.bug.st/serial v1.0.0/go.mod h1:rpXPISGjuNjPTRTcMlxi9lN6LoIPxd1ixVjBd8aSk/Q= +go.bug.st/serial.v1 v0.0.0-20180827123349-5f7892a7bb45 h1:mACY1anK6HNCZtm/DK2Rf2ZPHggVqeB0+7rY9Gl6wyI= +go.bug.st/serial.v1 v0.0.0-20180827123349-5f7892a7bb45/go.mod h1:dRSl/CVCTf56CkXgJMDOdSwNfo2g1orOGE/gBGdvjZw= +go.etcd.io/bbolt v1.3.2/go.mod h1:IbVyRI1SCnLcuJnV2u8VeU0CEYM7e686BmAb1XKL+uU= +go.uber.org/atomic v1.4.0/go.mod h1:gD2HeocX3+yG+ygLZcrzQJaqmWj9AIm7n08wl/qW/PE= +go.uber.org/multierr v1.1.0/go.mod h1:wR5kodmAFQ0UK8QlbwjlSNy0Z68gJhDJUG5sjR94q/0= +go.uber.org/zap v1.10.0/go.mod h1:vwi/ZaCAaUcBkycHslxD9B2zi4UTXhF60s6SWpuDF0Q= +golang.org/x/crypto v0.0.0-20180904163835-0709b304e793/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= +golang.org/x/crypto v0.0.0-20181203042331-505ab145d0a9/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2 h1:VklqNMn3ovrHsnt90PveolxSbWFaJdECFbxSq0Mqo2M= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= +golang.org/x/lint v0.0.0-20181026193005-c67002cb31c3/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE= +golang.org/x/lint v0.0.0-20190227174305-5b3e6a55c961/go.mod h1:wehouNa3lNwaWXcvxsM5YxQ5yQlVC4a0KAMCusXpPoU= +golang.org/x/lint v0.0.0-20190313153728-d0100b6bd8b3/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc= +golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20180826012351-8a410e7b638d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20181114220301-adae6a3d119a/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20181220203305-927f97764cc3/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20190213061140-3a22650c66bd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190522155817-f3200d17e092/go.mod h1:HSz+uSET+XFnRR8LxR5pz3Of3rY3CfYBVs4xY44aLks= +golang.org/x/net v0.0.0-20200202094626-16171245cfb2 h1:CCH4IOTTfewWjGOlSp+zGcjutRKlBEZQ6wTn8ozI/nI= +golang.org/x/net v0.0.0-20200202094626-16171245cfb2/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= +golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20181107165924-66b7b1311ac8/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20181116152217-5ac8a444bdc5/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20181205085412-a5c9d58dba9a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190222072716-a9d3bda3a223/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190422165155-953cdadca894/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20191128015809-6d18c012aee9/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200202164722-d101bd2416d5 h1:LfCXLvNmTYH9kEmVgqbnsWfruoXZIrh4YBgqVHtDvw0= +golang.org/x/sys v0.0.0-20200202164722-d101bd2416d5/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.2 h1:tW2bmiBqwgJj/UpqtC8EpXEZVYOwU0yG4iWbprSVAcs= +golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= +golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= +golang.org/x/tools v0.0.0-20180221164845-07fd8470d635/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20190226205152-f727befe758c/go.mod h1:9Yl7xja0Znq3iFh3HoIrodX9oNMXvdceNzlUR8zjMvY= +golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= +golang.org/x/tools v0.0.0-20190328211700-ab21143f2384/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= +golang.org/x/tools v0.0.0-20190524140312-2c0ae7006135/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q= +google.golang.org/appengine v1.1.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM= +google.golang.org/appengine v1.4.0/go.mod h1:xpcJRLb0r/rnEns0DIKYYv+WjYCduHsrkT7/EB5XEv4= +google.golang.org/genproto v0.0.0-20180817151627-c66870c02cf8/go.mod h1:JiN7NxoALGmiZfu7CAH4rXhgtRTLTxftemlI0sWmxmc= +google.golang.org/genproto v0.0.0-20190819201941-24fa4b261c55/go.mod h1:DMBHOl98Agz4BDEuKkezgsaosCRResVns1a3J2ZsMNc= +google.golang.org/genproto v0.0.0-20200204135345-fa8e72b47b90 h1:7THRSvPuzF1bql5kyFzX0JM0vpGhwuhskgJrJsbZ80Y= +google.golang.org/genproto v0.0.0-20200204135345-fa8e72b47b90/go.mod h1:GmwEX6Z4W5gMy59cAlVYjN9JhxgbQH6Gn+gFDQe2lzA= +google.golang.org/grpc v1.19.0/go.mod h1:mqu4LbDTu4XGKhr4mRzUsmM4RtVoemTSY81AxZiDr8c= +google.golang.org/grpc v1.21.0/go.mod h1:oYelfM1adQP15Ek0mdvEgi9Df8B9CZIaU1084ijfRaM= +google.golang.org/grpc v1.23.0/go.mod h1:Y5yQAOtifL1yxbo5wqy6BxZv8vAUGQwXBOALyacEbxg= +google.golang.org/grpc v1.27.0 h1:rRYRFMVgRv6E0D70Skyfsr28tDXIuuPZyWGMPdMcnXg= +google.golang.org/grpc v1.27.0/go.mod h1:qbnxyOmOxrQa7FizSgH+ReBfzJrCY1pSN7KXBS8abTk= +gopkg.in/alecthomas/kingpin.v2 v2.2.6/go.mod h1:FMv+mEhP44yOT+4EoQTLFTRgOQ1FBLkstjWtayDeSgw= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/mgo.v2 v2.0.0-20180705113604-9856a29383ce/go.mod h1:yeKp02qBN3iKW1OzL3MGk2IdtZzaj7SFntXj72NppTA= +gopkg.in/resty.v1 v1.12.0/go.mod h1:mDo4pnntr5jdWRML875a/NmxYqAlA73dVijT2AXvQQo= +gopkg.in/yaml.v2 v2.0.0-20170812160011-eb3733d160e7/go.mod h1:JAlM8MvJe8wmxCU4Bli9HhUf9+ttbYbLASfIpnQbh74= +gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw= +gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= +honnef.co/go/tools v0.0.0-20190523083050-ea95bdfd59fc/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= diff --git a/docsgen/main.go b/docsgen/main.go new file mode 100644 index 00000000000..d3286a117e8 --- /dev/null +++ b/docsgen/main.go @@ -0,0 +1,36 @@ +// This file is part of arduino-cli. +// +// Copyright 2020 ARDUINO SA (http://www.arduino.cc/) +// +// This software is released under the GNU General Public License version 3, +// which covers the main part of arduino-cli. +// The terms of this license can be found at: +// https://www.gnu.org/licenses/gpl-3.0.en.html +// +// You can be released from the requirements of the above licenses by purchasing +// a commercial license. Buying such a license is mandatory if you want to +// modify or otherwise use the software for commercial activities involving the +// Arduino software without disclosing the source code of your own applications. +// To purchase a commercial license, send an email to license@arduino.cc. + +package main + +import ( + "log" + "os" + + "github.com/arduino/arduino-cli/cli" + "github.com/spf13/cobra/doc" +) + +func main() { + if len(os.Args) < 2 { + log.Fatal("Please provide output folder") + } + + cli := cli.ArduinoCli + err := doc.GenMarkdownTree(cli, os.Args[1]) + if err != nil { + log.Fatal(err) + } +} From e4966d000eb016be86aa36eb7f3e9d5eea4342af Mon Sep 17 00:00:00 2001 From: Massimiliano Pippi Date: Wed, 4 Mar 2020 16:28:09 +0100 Subject: [PATCH 02/15] add first draft of docs --- docs/commands/arduino-cli.md | 42 +++ docs/commands/arduino-cli_board.md | 45 +++ docs/commands/arduino-cli_board_attach.md | 44 +++ docs/commands/arduino-cli_board_details.md | 41 +++ docs/commands/arduino-cli_board_list.md | 42 +++ docs/commands/arduino-cli_board_listall.md | 43 +++ docs/commands/arduino-cli_cache.md | 41 +++ docs/commands/arduino-cli_cache_clean.md | 41 +++ docs/commands/arduino-cli_compile.md | 56 ++++ docs/commands/arduino-cli_config.md | 39 +++ docs/commands/arduino-cli_config_dump.md | 41 +++ docs/commands/arduino-cli_config_init.md | 43 +++ docs/commands/arduino-cli_core.md | 44 +++ docs/commands/arduino-cli_core_download.md | 42 +++ docs/commands/arduino-cli_core_install.md | 45 +++ docs/commands/arduino-cli_core_list.md | 42 +++ docs/commands/arduino-cli_core_search.md | 42 +++ docs/commands/arduino-cli_core_uninstall.md | 42 +++ .../commands/arduino-cli_core_update-index.md | 41 +++ docs/commands/arduino-cli_core_upgrade.md | 45 +++ docs/commands/arduino-cli_daemon.md | 43 +++ docs/commands/arduino-cli_debug.md | 44 +++ docs/commands/arduino-cli_lib.md | 46 +++ docs/commands/arduino-cli_lib_deps.md | 42 +++ docs/commands/arduino-cli_lib_download.md | 42 +++ docs/commands/arduino-cli_lib_install.md | 43 +++ docs/commands/arduino-cli_lib_list.md | 43 +++ docs/commands/arduino-cli_lib_search.md | 42 +++ docs/commands/arduino-cli_lib_uninstall.md | 41 +++ docs/commands/arduino-cli_lib_update-index.md | 41 +++ docs/commands/arduino-cli_lib_upgrade.md | 43 +++ docs/commands/arduino-cli_sketch.md | 38 +++ docs/commands/arduino-cli_sketch_new.md | 41 +++ docs/commands/arduino-cli_upload.md | 45 +++ docs/commands/arduino-cli_version.md | 41 +++ docs/getting-started.md | 272 ++++++++++++++++++ docs/index.md | 156 ++++++++++ 37 files changed, 1924 insertions(+) create mode 100644 docs/commands/arduino-cli.md create mode 100644 docs/commands/arduino-cli_board.md create mode 100644 docs/commands/arduino-cli_board_attach.md create mode 100644 docs/commands/arduino-cli_board_details.md create mode 100644 docs/commands/arduino-cli_board_list.md create mode 100644 docs/commands/arduino-cli_board_listall.md create mode 100644 docs/commands/arduino-cli_cache.md create mode 100644 docs/commands/arduino-cli_cache_clean.md create mode 100644 docs/commands/arduino-cli_compile.md create mode 100644 docs/commands/arduino-cli_config.md create mode 100644 docs/commands/arduino-cli_config_dump.md create mode 100644 docs/commands/arduino-cli_config_init.md create mode 100644 docs/commands/arduino-cli_core.md create mode 100644 docs/commands/arduino-cli_core_download.md create mode 100644 docs/commands/arduino-cli_core_install.md create mode 100644 docs/commands/arduino-cli_core_list.md create mode 100644 docs/commands/arduino-cli_core_search.md create mode 100644 docs/commands/arduino-cli_core_uninstall.md create mode 100644 docs/commands/arduino-cli_core_update-index.md create mode 100644 docs/commands/arduino-cli_core_upgrade.md create mode 100644 docs/commands/arduino-cli_daemon.md create mode 100644 docs/commands/arduino-cli_debug.md create mode 100644 docs/commands/arduino-cli_lib.md create mode 100644 docs/commands/arduino-cli_lib_deps.md create mode 100644 docs/commands/arduino-cli_lib_download.md create mode 100644 docs/commands/arduino-cli_lib_install.md create mode 100644 docs/commands/arduino-cli_lib_list.md create mode 100644 docs/commands/arduino-cli_lib_search.md create mode 100644 docs/commands/arduino-cli_lib_uninstall.md create mode 100644 docs/commands/arduino-cli_lib_update-index.md create mode 100644 docs/commands/arduino-cli_lib_upgrade.md create mode 100644 docs/commands/arduino-cli_sketch.md create mode 100644 docs/commands/arduino-cli_sketch_new.md create mode 100644 docs/commands/arduino-cli_upload.md create mode 100644 docs/commands/arduino-cli_version.md create mode 100644 docs/getting-started.md create mode 100644 docs/index.md diff --git a/docs/commands/arduino-cli.md b/docs/commands/arduino-cli.md new file mode 100644 index 00000000000..db4ff914ded --- /dev/null +++ b/docs/commands/arduino-cli.md @@ -0,0 +1,42 @@ +## arduino-cli + +Arduino CLI. + +### Synopsis + +Arduino Command Line Interface (arduino-cli). + +### Examples + +``` + arduino-cli [flags...] +``` + +### Options + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + -h, --help help for arduino-cli + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli board](arduino-cli_board.md) - Arduino board commands. +* [arduino-cli cache](arduino-cli_cache.md) - Arduino cache commands. +* [arduino-cli compile](arduino-cli_compile.md) - Compiles Arduino sketches. +* [arduino-cli config](arduino-cli_config.md) - Arduino Configuration Commands. +* [arduino-cli core](arduino-cli_core.md) - Arduino Core operations. +* [arduino-cli daemon](arduino-cli_daemon.md) - Run as a daemon on port +* [arduino-cli debug](arduino-cli_debug.md) - Debug Arduino sketches. +* [arduino-cli lib](arduino-cli_lib.md) - Arduino commands about libraries. +* [arduino-cli sketch](arduino-cli_sketch.md) - Arduino CLI Sketch Commands. +* [arduino-cli upload](arduino-cli_upload.md) - Upload Arduino sketches. +* [arduino-cli version](arduino-cli_version.md) - Shows version number of arduino CLI. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_board.md b/docs/commands/arduino-cli_board.md new file mode 100644 index 00000000000..64e8af380dd --- /dev/null +++ b/docs/commands/arduino-cli_board.md @@ -0,0 +1,45 @@ +## arduino-cli board + +Arduino board commands. + +### Synopsis + +Arduino board commands. + +### Examples + +``` + # Lists all connected boards. + arduino-cli board list + + # Attaches a sketch to a board. + arduino-cli board attach serial:///dev/tty/ACM0 mySketch +``` + +### Options + +``` + -h, --help help for board +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli](arduino-cli.md) - Arduino CLI. +* [arduino-cli board attach](arduino-cli_board_attach.md) - Attaches a sketch to a board. +* [arduino-cli board details](arduino-cli_board_details.md) - Print details about a board. +* [arduino-cli board list](arduino-cli_board_list.md) - List connected boards. +* [arduino-cli board listall](arduino-cli_board_listall.md) - List all known boards and their corresponding FQBN. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_board_attach.md b/docs/commands/arduino-cli_board_attach.md new file mode 100644 index 00000000000..960eced1063 --- /dev/null +++ b/docs/commands/arduino-cli_board_attach.md @@ -0,0 +1,44 @@ +## arduino-cli board attach + +Attaches a sketch to a board. + +### Synopsis + +Attaches a sketch to a board. + +``` +arduino-cli board attach | [sketchPath] [flags] +``` + +### Examples + +``` + arduino-cli board attach serial:///dev/tty/ACM0 + arduino-cli board attach serial:///dev/tty/ACM0 HelloWorld + arduino-cli board attach arduino:samd:mkr1000 +``` + +### Options + +``` + -h, --help help for attach + --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") +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli board](arduino-cli_board.md) - Arduino board commands. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_board_details.md b/docs/commands/arduino-cli_board_details.md new file mode 100644 index 00000000000..5e25f3637d6 --- /dev/null +++ b/docs/commands/arduino-cli_board_details.md @@ -0,0 +1,41 @@ +## arduino-cli board details + +Print details about a board. + +### Synopsis + +Show information about a board, in particular if the board has options to be specified in the FQBN. + +``` +arduino-cli board details [flags] +``` + +### Examples + +``` + arduino-cli board details arduino:avr:nano +``` + +### Options + +``` + -h, --help help for details +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli board](arduino-cli_board.md) - Arduino board commands. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_board_list.md b/docs/commands/arduino-cli_board_list.md new file mode 100644 index 00000000000..ca2b4841f60 --- /dev/null +++ b/docs/commands/arduino-cli_board_list.md @@ -0,0 +1,42 @@ +## arduino-cli board list + +List connected boards. + +### Synopsis + +Detects and displays a list of connected boards to the current computer. + +``` +arduino-cli board list [flags] +``` + +### Examples + +``` + arduino-cli board list --timeout 10s +``` + +### Options + +``` + -h, --help help for list + --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") +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli board](arduino-cli_board.md) - Arduino board commands. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_board_listall.md b/docs/commands/arduino-cli_board_listall.md new file mode 100644 index 00000000000..758924b7356 --- /dev/null +++ b/docs/commands/arduino-cli_board_listall.md @@ -0,0 +1,43 @@ +## arduino-cli board listall + +List all known boards and their corresponding FQBN. + +### Synopsis + +List all boards that have the support platform installed. You can search +for a specific board if you specify the board name + +``` +arduino-cli board listall [boardname] [flags] +``` + +### Examples + +``` + arduino-cli board listall + arduino-cli board listall zero +``` + +### Options + +``` + -h, --help help for listall +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli board](arduino-cli_board.md) - Arduino board commands. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_cache.md b/docs/commands/arduino-cli_cache.md new file mode 100644 index 00000000000..bbd18ac8d26 --- /dev/null +++ b/docs/commands/arduino-cli_cache.md @@ -0,0 +1,41 @@ +## arduino-cli cache + +Arduino cache commands. + +### Synopsis + +Arduino cache commands. + +### Examples + +``` +# Clean caches. + arduino-cli cache clean + + +``` + +### Options + +``` + -h, --help help for cache +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli](arduino-cli.md) - Arduino CLI. +* [arduino-cli cache clean](arduino-cli_cache_clean.md) - Clean arduino cache. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_cache_clean.md b/docs/commands/arduino-cli_cache_clean.md new file mode 100644 index 00000000000..bc17c92c755 --- /dev/null +++ b/docs/commands/arduino-cli_cache_clean.md @@ -0,0 +1,41 @@ +## arduino-cli cache clean + +Clean arduino cache. + +### Synopsis + +Clean the files i.e. `~/arduino15/staging` in Linux. + +``` +arduino-cli cache clean [flags] +``` + +### Examples + +``` + arduino-cli cache clean +``` + +### Options + +``` + -h, --help help for clean +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli cache](arduino-cli_cache.md) - Arduino cache commands. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_compile.md b/docs/commands/arduino-cli_compile.md new file mode 100644 index 00000000000..5e4a75a659b --- /dev/null +++ b/docs/commands/arduino-cli_compile.md @@ -0,0 +1,56 @@ +## arduino-cli compile + +Compiles Arduino sketches. + +### Synopsis + +Compiles Arduino sketches. + +``` +arduino-cli compile [flags] +``` + +### Examples + +``` + arduino-cli compile -b arduino:avr:uno /home/user/Arduino/MySketch +``` + +### Options + +``` + --build-cache-path string Builds of 'core.a' are saved into this path to be cached and reused. + --build-path string Path where to save compiled files. If omitted, a directory will be created in the default temporary path of your OS. + --build-properties strings List of custom build properties separated by commas. Or can be used multiple times for multiple properties. + -b, --fqbn string Fully Qualified Board Name, e.g.: arduino:avr:uno + -h, --help help for compile + --libraries strings List of custom libraries paths separated by commas. Or can be used multiple times for multiple libraries paths. + --optimize-for-debug Optional, optimize compile output for debug, not for release. + -o, --output string Filename of the compile output. + -p, --port string Upload port, e.g.: COM10 or /dev/ttyACM0 + --preprocess Print preprocessed code to stdout instead of compiling. + --quiet Optional, supresses almost every output. + --show-properties Show all build properties used instead of compiling. + -u, --upload Upload the binary after the compilation. + -t, --verify Verify uploaded binary after the upload. + --vid-pid string When specified, VID/PID specific build properties are used, if boards supports them. + --warnings string Optional, can be "none", "default", "more" and "all". Defaults to "none". Used to tell gcc which warning level to use (-W flag). (default "none") +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli](arduino-cli.md) - Arduino CLI. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_config.md b/docs/commands/arduino-cli_config.md new file mode 100644 index 00000000000..b868b8291a5 --- /dev/null +++ b/docs/commands/arduino-cli_config.md @@ -0,0 +1,39 @@ +## arduino-cli config + +Arduino Configuration Commands. + +### Synopsis + +Arduino Configuration Commands. + +### Examples + +``` + arduino-cli config init +``` + +### Options + +``` + -h, --help help for config +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli](arduino-cli.md) - Arduino CLI. +* [arduino-cli config dump](arduino-cli_config_dump.md) - Prints the current configuration +* [arduino-cli config init](arduino-cli_config_init.md) - Initializes a new configuration file into the default location. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_config_dump.md b/docs/commands/arduino-cli_config_dump.md new file mode 100644 index 00000000000..7994f765034 --- /dev/null +++ b/docs/commands/arduino-cli_config_dump.md @@ -0,0 +1,41 @@ +## arduino-cli config dump + +Prints the current configuration + +### Synopsis + +Prints the current configuration. + +``` +arduino-cli config dump [flags] +``` + +### Examples + +``` + arduino-cli config dump +``` + +### Options + +``` + -h, --help help for dump +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli config](arduino-cli_config.md) - Arduino Configuration Commands. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_config_init.md b/docs/commands/arduino-cli_config_init.md new file mode 100644 index 00000000000..c00e6e11a49 --- /dev/null +++ b/docs/commands/arduino-cli_config_init.md @@ -0,0 +1,43 @@ +## arduino-cli config init + +Initializes a new configuration file into the default location. + +### Synopsis + +Initializes a new configuration file into the default location ($EXE_DIR/cli-config.yml). + +``` +arduino-cli config init [flags] +``` + +### Examples + +``` + # Creates a default configuration file into the default location. + arduino-cli config init +``` + +### Options + +``` + --dest-dir string Sets where to save the configuration file. + -h, --help help for init +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli config](arduino-cli_config.md) - Arduino Configuration Commands. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_core.md b/docs/commands/arduino-cli_core.md new file mode 100644 index 00000000000..def75810113 --- /dev/null +++ b/docs/commands/arduino-cli_core.md @@ -0,0 +1,44 @@ +## arduino-cli core + +Arduino Core operations. + +### Synopsis + +Arduino Core operations. + +### Examples + +``` + arduino-cli core update-index +``` + +### Options + +``` + -h, --help help for core +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli](arduino-cli.md) - Arduino CLI. +* [arduino-cli core download](arduino-cli_core_download.md) - Downloads one or more cores and corresponding tool dependencies. +* [arduino-cli core install](arduino-cli_core_install.md) - Installs one or more cores and corresponding tool dependencies. +* [arduino-cli core list](arduino-cli_core_list.md) - Shows the list of installed platforms. +* [arduino-cli core search](arduino-cli_core_search.md) - Search for a core in the package index. +* [arduino-cli core uninstall](arduino-cli_core_uninstall.md) - Uninstalls one or more cores and corresponding tool dependencies if no more used. +* [arduino-cli core update-index](arduino-cli_core_update-index.md) - Updates the index of cores. +* [arduino-cli core upgrade](arduino-cli_core_upgrade.md) - Upgrades one or all installed platforms to the latest version. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_core_download.md b/docs/commands/arduino-cli_core_download.md new file mode 100644 index 00000000000..d7da1d4a4dd --- /dev/null +++ b/docs/commands/arduino-cli_core_download.md @@ -0,0 +1,42 @@ +## arduino-cli core download + +Downloads one or more cores and corresponding tool dependencies. + +### Synopsis + +Downloads one or more cores and corresponding tool dependencies. + +``` +arduino-cli core download [PACKAGER:ARCH[=VERSION]](S) [flags] +``` + +### Examples + +``` + arduino-cli core download arduino:samd # to download the latest version of arduino SAMD core. + arduino-cli core download arduino:samd=1.6.9 # for a specific version (in this case 1.6.9). +``` + +### Options + +``` + -h, --help help for download +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli core](arduino-cli_core.md) - Arduino Core operations. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_core_install.md b/docs/commands/arduino-cli_core_install.md new file mode 100644 index 00000000000..5474402194d --- /dev/null +++ b/docs/commands/arduino-cli_core_install.md @@ -0,0 +1,45 @@ +## arduino-cli core install + +Installs one or more cores and corresponding tool dependencies. + +### Synopsis + +Installs one or more cores and corresponding tool dependencies. + +``` +arduino-cli core install PACKAGER:ARCH[@VERSION] ... [flags] +``` + +### Examples + +``` + # download the latest version of arduino SAMD core. + arduino-cli core install arduino:samd + + # download a specific version (in this case 1.6.9). + arduino-cli core install arduino:samd@1.6.9 +``` + +### Options + +``` + -h, --help help for install +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli core](arduino-cli_core.md) - Arduino Core operations. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_core_list.md b/docs/commands/arduino-cli_core_list.md new file mode 100644 index 00000000000..7516632301e --- /dev/null +++ b/docs/commands/arduino-cli_core_list.md @@ -0,0 +1,42 @@ +## arduino-cli core list + +Shows the list of installed platforms. + +### Synopsis + +Shows the list of installed platforms. + +``` +arduino-cli core list [flags] +``` + +### Examples + +``` + arduino-cli core list +``` + +### Options + +``` + -h, --help help for list + --updatable List updatable platforms. +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli core](arduino-cli_core.md) - Arduino Core operations. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_core_search.md b/docs/commands/arduino-cli_core_search.md new file mode 100644 index 00000000000..52fe5b20f42 --- /dev/null +++ b/docs/commands/arduino-cli_core_search.md @@ -0,0 +1,42 @@ +## arduino-cli core search + +Search for a core in the package index. + +### Synopsis + +Search for a core in the package index using the specified keywords. + +``` +arduino-cli core search [flags] +``` + +### Examples + +``` + arduino-cli core search MKRZero -a -v +``` + +### Options + +``` + -a, --all Show all available core versions. + -h, --help help for search +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli core](arduino-cli_core.md) - Arduino Core operations. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_core_uninstall.md b/docs/commands/arduino-cli_core_uninstall.md new file mode 100644 index 00000000000..25504841c76 --- /dev/null +++ b/docs/commands/arduino-cli_core_uninstall.md @@ -0,0 +1,42 @@ +## arduino-cli core uninstall + +Uninstalls one or more cores and corresponding tool dependencies if no more used. + +### Synopsis + +Uninstalls one or more cores and corresponding tool dependencies if no more used. + +``` +arduino-cli core uninstall PACKAGER:ARCH ... [flags] +``` + +### Examples + +``` + arduino-cli core uninstall arduino:samd + +``` + +### Options + +``` + -h, --help help for uninstall +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli core](arduino-cli_core.md) - Arduino Core operations. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_core_update-index.md b/docs/commands/arduino-cli_core_update-index.md new file mode 100644 index 00000000000..6ec6aa3be58 --- /dev/null +++ b/docs/commands/arduino-cli_core_update-index.md @@ -0,0 +1,41 @@ +## arduino-cli core update-index + +Updates the index of cores. + +### Synopsis + +Updates the index of cores to the latest version. + +``` +arduino-cli core update-index [flags] +``` + +### Examples + +``` + arduino-cli core update-index +``` + +### Options + +``` + -h, --help help for update-index +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli core](arduino-cli_core.md) - Arduino Core operations. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_core_upgrade.md b/docs/commands/arduino-cli_core_upgrade.md new file mode 100644 index 00000000000..b73598943fb --- /dev/null +++ b/docs/commands/arduino-cli_core_upgrade.md @@ -0,0 +1,45 @@ +## arduino-cli core upgrade + +Upgrades one or all installed platforms to the latest version. + +### Synopsis + +Upgrades one or all installed platforms to the latest version. + +``` +arduino-cli core upgrade [PACKAGER:ARCH] ... [flags] +``` + +### Examples + +``` + # upgrade everything to the latest version + arduino-cli core upgrade + + # upgrade arduino:samd to the latest version + arduino-cli core upgrade arduino:samd +``` + +### Options + +``` + -h, --help help for upgrade +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli core](arduino-cli_core.md) - Arduino Core operations. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_daemon.md b/docs/commands/arduino-cli_daemon.md new file mode 100644 index 00000000000..9ef28825c0f --- /dev/null +++ b/docs/commands/arduino-cli_daemon.md @@ -0,0 +1,43 @@ +## arduino-cli daemon + +Run as a daemon on port + +### Synopsis + +Running as a daemon the initialization of cores and libraries is done only once. + +``` +arduino-cli daemon [flags] +``` + +### Examples + +``` + arduino-cli daemon +``` + +### Options + +``` + --daemonize Do not terminate daemon process if the parent process dies + -h, --help help for daemon + --port string The TCP port the daemon will listen to +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli](arduino-cli.md) - Arduino CLI. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_debug.md b/docs/commands/arduino-cli_debug.md new file mode 100644 index 00000000000..2069936c534 --- /dev/null +++ b/docs/commands/arduino-cli_debug.md @@ -0,0 +1,44 @@ +## arduino-cli debug + +Debug Arduino sketches. + +### Synopsis + +Debug Arduino sketches. (this command opens an interactive gdb session) + +``` +arduino-cli debug [flags] +``` + +### Examples + +``` + arduino-cli debug -b arduino:samd:mkr1000 /home/user/Arduino/MySketch +``` + +### Options + +``` + -b, --fqbn string Fully Qualified Board Name, e.g.: arduino:avr:uno + -h, --help help for debug + -i, --input string Input file to be uploaded for debug. + -p, --port string Upload port, e.g.: COM10 or /dev/ttyACM0 +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli](arduino-cli.md) - Arduino CLI. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_lib.md b/docs/commands/arduino-cli_lib.md new file mode 100644 index 00000000000..42fff47bfea --- /dev/null +++ b/docs/commands/arduino-cli_lib.md @@ -0,0 +1,46 @@ +## arduino-cli lib + +Arduino commands about libraries. + +### Synopsis + +Arduino commands about libraries. + +### Examples + +``` + arduino-cli lib install AudioZero + arduino-cli lib update-index +``` + +### Options + +``` + -h, --help help for lib +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli](arduino-cli.md) - Arduino CLI. +* [arduino-cli lib deps](arduino-cli_lib_deps.md) - Check dependencies status for the specified library. +* [arduino-cli lib download](arduino-cli_lib_download.md) - Downloads one or more libraries without installing them. +* [arduino-cli lib install](arduino-cli_lib_install.md) - Installs one of more specified libraries into the system. +* [arduino-cli lib list](arduino-cli_lib_list.md) - Shows a list of all installed libraries. +* [arduino-cli lib search](arduino-cli_lib_search.md) - Searches for one or more libraries data. +* [arduino-cli lib uninstall](arduino-cli_lib_uninstall.md) - Uninstalls one or more libraries. +* [arduino-cli lib update-index](arduino-cli_lib_update-index.md) - Updates the libraries index. +* [arduino-cli lib upgrade](arduino-cli_lib_upgrade.md) - Upgrades installed libraries. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_lib_deps.md b/docs/commands/arduino-cli_lib_deps.md new file mode 100644 index 00000000000..e287fc0de8e --- /dev/null +++ b/docs/commands/arduino-cli_lib_deps.md @@ -0,0 +1,42 @@ +## arduino-cli lib deps + +Check dependencies status for the specified library. + +### Synopsis + +Check dependencies status for the specified library. + +``` +arduino-cli lib deps LIBRARY[@VERSION_NUMBER](S) [flags] +``` + +### Examples + +``` + arduino-cli lib deps AudioZero # for the latest version. + arduino-cli lib deps AudioZero@1.0.0 # for the specific version. +``` + +### Options + +``` + -h, --help help for deps +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli lib](arduino-cli_lib.md) - Arduino commands about libraries. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_lib_download.md b/docs/commands/arduino-cli_lib_download.md new file mode 100644 index 00000000000..50ce9359c72 --- /dev/null +++ b/docs/commands/arduino-cli_lib_download.md @@ -0,0 +1,42 @@ +## arduino-cli lib download + +Downloads one or more libraries without installing them. + +### Synopsis + +Downloads one or more libraries without installing them. + +``` +arduino-cli lib download [LIBRARY_NAME(S)] [flags] +``` + +### Examples + +``` + arduino-cli lib download AudioZero # for the latest version. + arduino-cli lib download AudioZero@1.0.0 # for a specific version. +``` + +### Options + +``` + -h, --help help for download +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli lib](arduino-cli_lib.md) - Arduino commands about libraries. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_lib_install.md b/docs/commands/arduino-cli_lib_install.md new file mode 100644 index 00000000000..a54ad953ae7 --- /dev/null +++ b/docs/commands/arduino-cli_lib_install.md @@ -0,0 +1,43 @@ +## arduino-cli lib install + +Installs one of more specified libraries into the system. + +### Synopsis + +Installs one or more specified libraries into the system. + +``` +arduino-cli lib install LIBRARY[@VERSION_NUMBER](S) [flags] +``` + +### Examples + +``` + arduino-cli lib install AudioZero # for the latest version. + arduino-cli lib install AudioZero@1.0.0 # for the specific version. +``` + +### Options + +``` + -h, --help help for install + --no-deps Do not install dependencies. +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli lib](arduino-cli_lib.md) - Arduino commands about libraries. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_lib_list.md b/docs/commands/arduino-cli_lib_list.md new file mode 100644 index 00000000000..8870c3984c6 --- /dev/null +++ b/docs/commands/arduino-cli_lib_list.md @@ -0,0 +1,43 @@ +## arduino-cli lib list + +Shows a list of all installed libraries. + +### Synopsis + +Shows a list of all installed libraries. + +``` +arduino-cli lib list [flags] +``` + +### Examples + +``` + arduino-cli lib list +``` + +### Options + +``` + --all Include built-in libraries (from platforms and IDE) in listing. + -h, --help help for list + --updatable List updatable libraries. +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli lib](arduino-cli_lib.md) - Arduino commands about libraries. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_lib_search.md b/docs/commands/arduino-cli_lib_search.md new file mode 100644 index 00000000000..c3f76e49f39 --- /dev/null +++ b/docs/commands/arduino-cli_lib_search.md @@ -0,0 +1,42 @@ +## arduino-cli lib search + +Searches for one or more libraries data. + +### Synopsis + +Search for one or more libraries data (case insensitive search). + +``` +arduino-cli lib search [LIBRARY_NAME] [flags] +``` + +### Examples + +``` + arduino-cli lib search audio +``` + +### Options + +``` + -h, --help help for search + --names Show library names only. +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli lib](arduino-cli_lib.md) - Arduino commands about libraries. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_lib_uninstall.md b/docs/commands/arduino-cli_lib_uninstall.md new file mode 100644 index 00000000000..7f528f46092 --- /dev/null +++ b/docs/commands/arduino-cli_lib_uninstall.md @@ -0,0 +1,41 @@ +## arduino-cli lib uninstall + +Uninstalls one or more libraries. + +### Synopsis + +Uninstalls one or more libraries. + +``` +arduino-cli lib uninstall LIBRARY_NAME(S) [flags] +``` + +### Examples + +``` + arduino-cli lib uninstall AudioZero +``` + +### Options + +``` + -h, --help help for uninstall +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli lib](arduino-cli_lib.md) - Arduino commands about libraries. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_lib_update-index.md b/docs/commands/arduino-cli_lib_update-index.md new file mode 100644 index 00000000000..227ad1815cd --- /dev/null +++ b/docs/commands/arduino-cli_lib_update-index.md @@ -0,0 +1,41 @@ +## arduino-cli lib update-index + +Updates the libraries index. + +### Synopsis + +Updates the libraries index to the latest version. + +``` +arduino-cli lib update-index [flags] +``` + +### Examples + +``` + arduino-cli lib update-index +``` + +### Options + +``` + -h, --help help for update-index +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli lib](arduino-cli_lib.md) - Arduino commands about libraries. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_lib_upgrade.md b/docs/commands/arduino-cli_lib_upgrade.md new file mode 100644 index 00000000000..4bd3eb27b95 --- /dev/null +++ b/docs/commands/arduino-cli_lib_upgrade.md @@ -0,0 +1,43 @@ +## arduino-cli lib upgrade + +Upgrades installed libraries. + +### Synopsis + +This command upgrades an installed library to the latest available version. Multiple libraries can be passed separated by a space. If no arguments are provided, the command will upgrade all the installed libraries where an update is available. + +``` +arduino-cli lib upgrade [flags] +``` + +### Examples + +``` + arduino-cli lib upgrade + arduino-cli lib upgrade Audio + arduino-cli lib upgrade Audio ArduinoJson +``` + +### Options + +``` + -h, --help help for upgrade +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli lib](arduino-cli_lib.md) - Arduino commands about libraries. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_sketch.md b/docs/commands/arduino-cli_sketch.md new file mode 100644 index 00000000000..00360bfff35 --- /dev/null +++ b/docs/commands/arduino-cli_sketch.md @@ -0,0 +1,38 @@ +## arduino-cli sketch + +Arduino CLI Sketch Commands. + +### Synopsis + +Arduino CLI Sketch Commands. + +### Examples + +``` + arduino-cli sketch new MySketch +``` + +### Options + +``` + -h, --help help for sketch +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli](arduino-cli.md) - Arduino CLI. +* [arduino-cli sketch new](arduino-cli_sketch_new.md) - Create a new Sketch + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_sketch_new.md b/docs/commands/arduino-cli_sketch_new.md new file mode 100644 index 00000000000..901c46b2b34 --- /dev/null +++ b/docs/commands/arduino-cli_sketch_new.md @@ -0,0 +1,41 @@ +## arduino-cli sketch new + +Create a new Sketch + +### Synopsis + +Create a new Sketch + +``` +arduino-cli sketch new [flags] +``` + +### Examples + +``` + arduino-cli sketch new MultiBlinker +``` + +### Options + +``` + -h, --help help for new +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli sketch](arduino-cli_sketch.md) - Arduino CLI Sketch Commands. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_upload.md b/docs/commands/arduino-cli_upload.md new file mode 100644 index 00000000000..524c04f5b18 --- /dev/null +++ b/docs/commands/arduino-cli_upload.md @@ -0,0 +1,45 @@ +## arduino-cli upload + +Upload Arduino sketches. + +### Synopsis + +Upload Arduino sketches. + +``` +arduino-cli upload [flags] +``` + +### Examples + +``` + arduino-cli upload /home/user/Arduino/MySketch +``` + +### Options + +``` + -b, --fqbn string Fully Qualified Board Name, e.g.: arduino:avr:uno + -h, --help help for upload + -i, --input string Input file to be uploaded. + -p, --port string Upload port, e.g.: COM10 or /dev/ttyACM0 + -t, --verify Verify uploaded binary after the upload. +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli](arduino-cli.md) - Arduino CLI. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_version.md b/docs/commands/arduino-cli_version.md new file mode 100644 index 00000000000..3849872b709 --- /dev/null +++ b/docs/commands/arduino-cli_version.md @@ -0,0 +1,41 @@ +## arduino-cli version + +Shows version number of arduino CLI. + +### Synopsis + +Shows version number of arduino CLI which is installed on your system. + +``` +arduino-cli version [flags] +``` + +### Examples + +``` + arduino-cli version +``` + +### Options + +``` + -h, --help help for version +``` + +### Options inherited from parent commands + +``` + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic + -v, --verbose Print the logs on the standard output. +``` + +### SEE ALSO + +* [arduino-cli](arduino-cli.md) - Arduino CLI. + +###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/getting-started.md b/docs/getting-started.md new file mode 100644 index 00000000000..88248bbb497 --- /dev/null +++ b/docs/getting-started.md @@ -0,0 +1,272 @@ +Despite there's no feature parity at the moment, Arduino CLI provides many of +the features you can find in the Arduino IDE, let's see some examples. + +## Create a configuration file + +Arduino CLI doesn't strictly require a configuration file to work because the +command line interface provides any possible functionality. However, having one +can spare you a lot of typing when issuing a command, so let's create it +right ahead with: + +```sh +$ arduino-cli config init +Config file written: /home/luca/.arduino15/arduino-cli.yaml +``` + +If you inspect `arduino-cli.yaml` contents, you'll find out the available +options with their respective default values. + +## Create a new sketch + +To create a new sketch named `MyFirstSketch` in the current directory, run +the following command: + +```sh +$ arduino-cli sketch new MyFirstSketch +Sketch created in: /home/luca/MyFirstSketch +``` + +A sketch is a folder containing assets like source files and libraries; the +`new` command creates for you a .ino file called `MyFirstSketch.ino` +containing Arduino boilerplate code: + +```sh +$ cat $HOME/MyFirstSketch/MyFirstSketch.ino +void setup() { +} + +void loop() { +} +``` + +At this point you can use your favourite file editor or IDE to open the +file `$HOME/MyFirstSketch/MyFirstSketch.ino` and change the code like this: + +```c +void setup() { + pinMode(LED_BUILTIN, OUTPUT); +} + +void loop() { + digitalWrite(LED_BUILTIN, HIGH); + delay(1000); + digitalWrite(LED_BUILTIN, LOW); + delay(1000); +} +``` + +## Connect the board to your PC + +The first thing to do upon a fresh install is to update the local cache of +available platforms and libraries by running: + +```sh +$ arduino-cli core update-index +Updating index: package_index.json downloaded +``` + +After connecting the board to your PCs by using the USB cable, you should be +able to check whether it's been recognized by running: + +```sh +$ arduino-cli board list +Port Type Board Name FQBN Core +/dev/ttyACM1 Serial Port (USB) Arduino/Genuino MKR1000 arduino:samd:mkr1000 arduino:samd +``` + +In this example, the MKR1000 board was recognized and from the output of the +command you see the platform core called `arduino:samd` is the one that needs +to be installed to make it work. + +If you see an `Unknown` board listed, uploading +should still work as long as you identify the platform core and use the correct +FQBN string. When a board is not detected for whatever reason, you can list all +the supported boards and their FQBN strings by running the following: + +```sh +$ arduino-cli board listall mkr +Board Name FQBN +Arduino MKR FOX 1200 arduino:samd:mkrfox1200 +Arduino MKR GSM 1400 arduino:samd:mkrgsm1400 +Arduino MKR WAN 1300 arduino:samd:mkrwan1300 +Arduino MKR WiFi 1010 arduino:samd:mkrwifi1010 +Arduino MKRZERO arduino:samd:mkrzero +Arduino/Genuino MKR1000 arduino:samd:mkr1000 +``` + +## Install the core for your board + +To install the ``arduino:samd`` platform core, run the following: + +```sh +$ arduino-cli core install arduino:samd +Downloading tools... +arduino:arm-none-eabi-gcc@4.8.3-2014q1 downloaded +arduino:bossac@1.7.0 downloaded +arduino:openocd@0.9.0-arduino6-static downloaded +arduino:CMSIS@4.5.0 downloaded +arduino:CMSIS-Atmel@1.1.0 downloaded +arduino:arduinoOTA@1.2.0 downloaded +Downloading cores... +arduino:samd@1.6.19 downloaded +Installing tools... +Installing platforms... +Results: +arduino:samd@1.6.19 - Installed +arduino:arm-none-eabi-gcc@4.8.3-2014q1 - Installed +arduino:bossac@1.7.0 - Installed +arduino:openocd@0.9.0-arduino6-static - Installed +arduino:CMSIS@4.5.0 - Installed +arduino:CMSIS-Atmel@1.1.0 - Installed +arduino:arduinoOTA@1.2.0 - Installed +``` + +Now verify we have installed the core properly by running: + +```sh +$ arduino-cli core list +ID Installed Latest Name +arduino:samd 1.6.19 1.6.19 Arduino SAMD Boards (32-bits ARM Cortex-M0+) +``` + +Great! Now we are ready to compile and upload the sketch. + +## Adding 3rd party cores + +If your board requires 3rd party core packages to work, you can list the URLs +to additional package indexes in the Arduino CLI configuration file. + +For example, to add the ESP8266 core, edit the configuration file and change the +`board_manager` settings as follows: + +```yaml +board_manager: + additional_urls: + - https://arduino.esp8266.com/stable/package_esp8266com_index.json +``` + +From now on, commands supporting custom cores will automatically use the +additional URL from the configuration file: + +```sh +$ arduino-cli core update-index +Updating index: package_index.json downloaded +Updating index: package_esp8266com_index.json downloaded +Updating index: package_index.json downloaded + +$ arduino-cli core search esp8266 +ID Version Name +esp8266:esp8266 2.5.2 esp8266 +``` + +Alternatively, you can pass a link to the the additional package index file with +the `--additional-urls` option, that has to be specified every time and for every +command that operates on a 3rd party platform core, for example: + +```sh +$ arduino-cli core update-index --additional-urls https://arduino.esp8266.com/stable/package_esp8266com_index.json +Updating index: package_esp8266com_index.json downloaded + +$ arduino-cli core search esp8266 --additional-urls https://arduino.esp8266.com/stable/package_esp8266com_index.json +ID Version Name +esp8266:esp8266 2.5.2 esp8266 +``` + +## Compile and upload the sketch + +To compile the sketch you run the `compile` command passing the proper FQBN +string: + +```sh +$ arduino-cli compile --fqbn arduino:samd:mkr1000 MyFirstSketch +Sketch uses 9600 bytes (3%) of program storage space. Maximum is 262144 bytes. +``` + +To upload the sketch to your board, run the following command, this time also +providing the serial port where the board is connected: + +```sh +$ arduino-cli upload -p /dev/ttyACM0 --fqbn arduino:samd:mkr1000 MyFirstSketch +No new serial port detected. +Atmel SMART device 0x10010005 found +Device : ATSAMD21G18A +Chip ID : 10010005 +Version : v2.0 [Arduino:XYZ] Dec 20 2016 15:36:43 +Address : 8192 +Pages : 3968 +Page Size : 64 bytes +Total Size : 248KB +Planes : 1 +Lock Regions : 16 +Locked : none +Security : false +Boot Flash : true +BOD : true +BOR : true +Arduino : FAST_CHIP_ERASE +Arduino : FAST_MULTI_PAGE_WRITE +Arduino : CAN_CHECKSUM_MEMORY_BUFFER +Erase flash +done in 0.784 seconds + +Write 9856 bytes to flash (154 pages) +[==============================] 100% (154/154 pages) +done in 0.069 seconds + +Verify 9856 bytes of flash with checksum. +Verify successful +done in 0.009 seconds +CPU reset. +``` + +## Add libraries + +If you need to add more functionalities to your sketch, chances are some of the +libraries available in the Arduino ecosystem already provide what you need. +For example, if you need a debouncing strategy to better handle button inputs, +you can try searching for the `debouncer` keyword: + +```sh +$ arduino-cli lib search debouncer +Name: "Debouncer" + Author: hideakitai + Maintainer: hideakitai + Sentence: Debounce library for Arduino + Paragraph: Debounce library for Arduino + Website: https://github.com/hideakitai + Category: Timing + Architecture: * + Types: Contributed + Versions: [0.1.0] +Name: "FTDebouncer" + Author: Ubi de Feo + Maintainer: Ubi de Feo, Sebastian Hunkeler + Sentence: An efficient, low footprint, fast pin debouncing library for Arduino + Paragraph: This pin state supervisor manages debouncing of buttons and handles transitions between LOW and HIGH state, calling a function and notifying your code of which pin has been activated or deactivated. + Website: https://github.com/ubidefeo/FTDebouncer + Category: Uncategorized + Architecture: * + Types: Contributed + Versions: [1.3.0] +Name: "SoftTimer" + Author: Balazs Kelemen + Maintainer: Balazs Kelemen + Sentence: SoftTimer is a lightweight pseudo multitasking solution for Arduino. + Paragraph: SoftTimer enables higher level Arduino programing, yet easy to use, and lightweight. You are often faced with the problem that you need to do multiple tasks at the same time. In SoftTimer, the programmer creates Tasks that runs periodically. This library comes with a collection of handy tools like blinker, pwm, debouncer. + Website: https://github.com/prampec/arduino-softtimer + Category: Timing + Architecture: * + Types: Contributed + Versions: [3.0.0, 3.1.0, 3.1.1, 3.1.2, 3.1.3, 3.1.5, 3.2.0] +``` + +Our favourite is ``FTDebouncer``, let's install it by running: + +```sh +$ arduino-cli lib install FTDebouncer +FTDebouncer depends on FTDebouncer@1.3.0 +Downloading FTDebouncer@1.3.0... +FTDebouncer@1.3.0 downloaded +Installing FTDebouncer@1.3.0... +Installed FTDebouncer@1.3.0 +``` diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000000..7c4963fd6cb --- /dev/null +++ b/docs/index.md @@ -0,0 +1,156 @@ +Arduino CLI is an all-in-one solution that provides builder, boards/library manager, +uploader, discovery and many other tools needed to use any Arduino compatible board +and platforms. + +## Installation + +You have several options to install the latest version of the Arduino +CLI on your system. + +### Install via Homebrew (macOS/Linux) + +The Arduino CLI is available as a Homebrew formula since version +`0.5.0`: + +```sh +brew update +brew install arduino-cli +``` + +### Use the install script + +The easiest way to get the latest version of the Arduino CLI on any +supported platform is using the `install.sh` script: + +```sh +curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | sh +``` + +The script will install `arduino-cli` at `$PWD/bin` but if you want to target a +different directory, for example `~/local/bin`, set the `BINDIR` environment +variable like this: + +```sh +curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | BINDIR=~/local/bin sh +``` + +### Download the latest packages + +You can download the latest version of the pre-built binaries for the supported +platforms from the [release page](https://github.com/arduino/arduino-cli/releases) +or following the links in the following table. Once downloaded, extract the +binary `arduino-cli` into a directory that's is in your `PATH`. + +Platform | | | +--------- | ------------------ | ------------------ | +Linux | [Linux 32 bit] | [Linux 64 bit] | +Linux ARM | [Linux ARM 32 bit] | [Linux ARM 64 bit] | +Windows | [Windows 32 bit] | [Windows 64 bit] | +Mac OSX | | [Mac OSX] | + +[Linux 64 bit]: https://downloads.arduino.cc/arduino-cli/arduino-cli_latest_Linux_64bit.tar.gz +[Linux 32 bit]: https://downloads.arduino.cc/arduino-cli/arduino-cli_latest_Linux_32bit.tar.gz +[Linux ARM 64 bit]: https://downloads.arduino.cc/arduino-cli/arduino-cli_latest_Linux_ARM64.tar.gz +[Linux ARM 32 bit]: https://downloads.arduino.cc/arduino-cli/arduino-cli_latest_Linux_ARMv7.tar.gz +[Windows 64 bit]: https://downloads.arduino.cc/arduino-cli/arduino-cli_latest_Windows_64bit.zip +[Windows 32 bit]: https://downloads.arduino.cc/arduino-cli/arduino-cli_latest_Windows_32bit.zip +[Mac OSX]: https://downloads.arduino.cc/arduino-cli/arduino-cli_latest_macOS_64bit.tar.gz + +> **Deprecation notice**: links in the form + `http://downloads.arduino.cc/arduino-cli/arduino-cli-latest-.tar.bz2` + won’t be further updated. That URL will provide the version + `0.3.7-alpha.preview`, regardless of further releases. + +### Download a nightly build + +These builds are generated everyday at 01:00 GMT from the `master` branch and +should be considered unstable. In order to get the latest nightly build +available for the supported platform, use the following links: + +Platform | | | +--------- | -------------------------- | -------------------------- | +Linux | [Nightly Linux 32 bit] | [Nightly Linux 64 bit] | +Linux ARM | [Nightly Linux ARM 32 bit] | [Nightly Linux ARM 64 bit] | +Windows | [Nightly Windows 32 bit] | [Nightly Windows 64 bit] | +Mac OSX | | [Mac OSX] | + +[Nightly Linux 64 bit]: https://downloads.arduino.cc/arduino-cli/nightly/arduino-cli_nightly-latest_Linux_64bit.tar.gz +[Nightly Windows 32 bit]: https://downloads.arduino.cc/arduino-cli/nightly/arduino-cli_nightly-latest_Linux_32bit.tar.gz +[Nightly Linux ARM 64 bit]: https://downloads.arduino.cc/arduino-cli/nightly/arduino-cli_nightly-latest_Linux_ARM64.tar.gz +[Nightly Linux ARM 32 bit]: https://downloads.arduino.cc/arduino-cli/nightly/arduino-cli_nightly-latest_Linux_ARMv7.tar.gz +[Nightly Windows 64 bit]: https://downloads.arduino.cc/arduino-cli/nightly/arduino-cli_nightly-latest_Windows_64bit.zip +[Nightly Windows 32 bit]: https://downloads.arduino.cc/arduino-cli/nightly/arduino-cli_nightly-latest_Windows_32bit.zip +[Nightly Mac OSX]: https://downloads.arduino.cc/arduino-cli/nightly/arduino-cli_nightly-latest_macOS_64bit.tar.gz + +> These links return a `302: Found` response, redirecting to latest + generated builds by replacing `latest` with the latest available build + date, using the format YYYYMMDD (i.e for 2019/Aug/06 `latest` is + replaced with `20190806` ) + +Checksums for the nightly builds are available at +`https://downloads.arduino.cc/arduino-cli/nightly/nightly--checksums.txt` + +Once downloaded, extract the executable `arduino-cli` into a directory +which is in your ``PATH``. + +### Build from source + +If you’re familiar with Golang or if you want to contribute to the +project, you will probably build the `arduino-cli` locally with your +Go toolchain. Please refer to the [contributing] document for setup instructions. + +If you don’t have a working Golang environment or if you want to build +`arduino-cli` targeting different platforms, you can use Docker to get +a binary directly from sources. From the project folder run: + +```sh +docker run -v $PWD:/arduino-cli -w /arduino-cli -e PACKAGE_NAME_PREFIX='snapshot' arduino/arduino-cli:builder-1 goreleaser --rm-dist --snapshot --skip-publish +``` + +Once the build is over, you will find a `./dist/` folder containing the packages +built out of the current source tree. + +## Getting started + +`arduino-cli` is a container of commands and each command has its own +dedicated help text that can be shown with the `help` command like this: + +```console +$ arduino-cli help core +Arduino Core operations. + +Usage: + arduino-cli core [command] + +Examples: + ./arduino-cli core update-index + +Available Commands: + download Downloads one or more cores and corresponding tool dependencies. + install Installs one or more cores and corresponding tool dependencies. + list Shows the list of installed platforms. + search Search for a core in the package index. + uninstall Uninstalls one or more cores and corresponding tool dependencies if no more used. + update-index Updates the index of cores. + upgrade Upgrades one or all installed platforms to the latest version. + +Flags: + -h, --help help for core + +Global Flags: + --additional-urls strings Additional URLs for the board manager. + --config-file string The custom config file (if not specified the default will be used). + --format string The output format, can be [text|json]. (default "text") + --log-file string Path to the file where logs will be written. + --log-format string The output format for the logs, can be [text|json]. + --log-level string Messages with this level and above will be logged. + -v, --verbose Print the logs on the standard output. + +Use "arduino-cli core [command] --help" for more information about a command. +``` + +Follow the [Getting started guide](/getting-started/) to see how to use the most +common CLI commands available. + + +[contributing]: https://github.com/arduino/arduino-cli/blob/master/CONTRIBUTING.md From f91e6d07e9f2a024e26047f576459891bc11b3a4 Mon Sep 17 00:00:00 2001 From: Massimiliano Pippi Date: Wed, 4 Mar 2020 16:28:24 +0100 Subject: [PATCH 03/15] add mkdocs build --- .github/workflows/docs.yaml | 58 ++++++++++++++++++++++ mkdocs.yml | 96 +++++++++++++++++++++++++++++++++++++ requirements_docs.txt | 2 + 3 files changed, 156 insertions(+) create mode 100644 .github/workflows/docs.yaml create mode 100644 mkdocs.yml create mode 100644 requirements_docs.txt diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml new file mode 100644 index 00000000000..1d3a8d5accc --- /dev/null +++ b/.github/workflows/docs.yaml @@ -0,0 +1,58 @@ +name: docs + +on: + push: + branches: + - master + pull_request: + paths: + - 'docs/**' + - 'docsgen/**' + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v2 + + - name: Install Taskfile + uses: Arduino/actions/setup-taskfile@master + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + + - name: Setup Go + uses: actions/setup-go@v1 + + - name: Setup Python + uses: actions/setup-python@v1 + with: + python-version: '3.6' + architecture: 'x64' + + - name: Cache dependencies + uses: actions/cache@v1 + with: + path: ~/.cache/pip + key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }} + restore-keys: | + ${{ runner.os }}-pip- + + - name: Install dependencies + run: | + python3 -m pip install --upgrade pip + python3 -m pip install -r ./requirements_docs.txt + + - name: Generate command reference + working-directory: docsgen + run: task gen:commands + + - name: Build docs website + run: mkdocs build -s + + # - name: Deploy + # uses: peaceiris/actions-gh-pages@v3 + # with: + # github_token: ${{ secrets.GITHUB_TOKEN }} + # publish_dir: ./docs \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000000..663957b2752 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,96 @@ +# Project information +site_name: Arduino CLI +site_description: Arduino Command Line Interface +site_url: https://arduino.github.io/arduino-cli/ + +# Repository +repo_name: arduino/arduino-cli +repo_url: https://github.com/arduino/arduino-cli +edit_uri: "" + +# Copyright +copyright: 'Copyright 2020 ARDUINO SA (http://www.arduino.cc/)' + +# Configuration +site_dir: public +edit_uri: "" + +# Theme +theme: + name: material + palette: + primary: teal + accent: orange + +# Extensions +markdown_extensions: + - markdown.extensions.admonition + - markdown.extensions.codehilite: + guess_lang: false + - markdown.extensions.def_list + - markdown.extensions.footnotes + - markdown.extensions.meta + - markdown.extensions.toc: + permalink: true + - pymdownx.arithmatex + - pymdownx.betterem: + smart_enable: all + - pymdownx.caret + - pymdownx.critic + - pymdownx.details + - pymdownx.emoji: + emoji_index: !!python/name:pymdownx.emoji.twemoji + emoji_generator: !!python/name:pymdownx.emoji.to_svg + - pymdownx.inlinehilite + - pymdownx.keys + - pymdownx.magiclink: + repo_url_shorthand: true + user: squidfunk + repo: mkdocs-material + - pymdownx.mark + - pymdownx.smartsymbols + - pymdownx.superfences + - pymdownx.tasklist: + custom_checkbox: true + - pymdownx.tilde + +# Navigation +nav: + - Documentation Home: 'index.md' + - getting-started.md + - Command reference: + - commands/arduino-cli.md + - board: commands/arduino-cli_board.md + - board attach: commands/arduino-cli_board_attach.md + - board details: commands/arduino-cli_board_details.md + - board list: commands/arduino-cli_board_list.md + - board listall: commands/arduino-cli_board_listall.md + - cache: commands/arduino-cli_cache.md + - cache clean: commands/arduino-cli_cache_clean.md + - compile: commands/arduino-cli_compile.md + - config: commands/arduino-cli_config.md + - config dump: commands/arduino-cli_config_dump.md + - config init: commands/arduino-cli_config_init.md + - core: commands/arduino-cli_core.md + - core download: commands/arduino-cli_core_download.md + - core install: commands/arduino-cli_core_install.md + - core list: commands/arduino-cli_core_list.md + - core search: commands/arduino-cli_core_search.md + - core uninstall: commands/arduino-cli_core_uninstall.md + - core update index: commands/arduino-cli_core_update-index.md + - core upgrade: commands/arduino-cli_core_upgrade.md + - daemon: commands/arduino-cli_daemon.md + - debug: commands/arduino-cli_debug.md + - lib: commands/arduino-cli_lib.md + - lib deps: commands/arduino-cli_lib_deps.md + - lib download: commands/arduino-cli_lib_download.md + - lib install: commands/arduino-cli_lib_install.md + - lib list: commands/arduino-cli_lib_list.md + - lib search: commands/arduino-cli_lib_search.md + - lib uninstall: commands/arduino-cli_lib_uninstall.md + - lib update-index: commands/arduino-cli_lib_update-index.md + - lib upgrade: commands/arduino-cli_lib_upgrade.md + - sketch: commands/arduino-cli_sketch.md + - sketch new: commands/arduino-cli_sketch_new.md + - upload: commands/arduino-cli_upload.md + - version: commands/arduino-cli_version.md diff --git a/requirements_docs.txt b/requirements_docs.txt new file mode 100644 index 00000000000..21f876b4370 --- /dev/null +++ b/requirements_docs.txt @@ -0,0 +1,2 @@ +mkdocs +mkdocs-material \ No newline at end of file From 36a82ecff0ecab301ee0ce866d3c60cb57803e82 Mon Sep 17 00:00:00 2001 From: Massimiliano Pippi Date: Wed, 4 Mar 2020 16:35:36 +0100 Subject: [PATCH 04/15] use more recent action --- .github/workflows/docs.yaml | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 1d3a8d5accc..d1a94c06744 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -23,7 +23,12 @@ jobs: repo-token: ${{ secrets.GITHUB_TOKEN }} - name: Setup Go - uses: actions/setup-go@v1 + uses: actions/setup-go@v2-beta + with: + go-version: '1.13' + + - name: Print Go version + run: go version - name: Setup Python uses: actions/setup-python@v1 From 906a0bfe98a592b687cef39d9bc4ce761fda62e7 Mon Sep 17 00:00:00 2001 From: Massimiliano Pippi Date: Wed, 4 Mar 2020 16:43:29 +0100 Subject: [PATCH 05/15] add GH pages deploy step --- .github/workflows/docs.yaml | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index d1a94c06744..9313528b403 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -56,8 +56,9 @@ jobs: - name: Build docs website run: mkdocs build -s - # - name: Deploy - # uses: peaceiris/actions-gh-pages@v3 - # with: - # github_token: ${{ secrets.GITHUB_TOKEN }} - # publish_dir: ./docs \ No newline at end of file + - name: Deploy + if: + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./public \ No newline at end of file From 1322cfc17d7466bd1c4a65bf6cbb80a67092da89 Mon Sep 17 00:00:00 2001 From: Massimiliano Pippi Date: Wed, 4 Mar 2020 17:22:04 +0100 Subject: [PATCH 06/15] publish docs only when pr is merged --- .github/workflows/docs.yaml | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 9313528b403..c4177dcf2ad 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -1,9 +1,6 @@ name: docs on: - push: - branches: - - master pull_request: paths: - 'docs/**' @@ -57,7 +54,8 @@ jobs: run: mkdocs build -s - name: Deploy - if: + # publish docs only when PR is merged + if: github.event.pull_request.merged == 'true' uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} From 4dd1ac7593272b39828afa02137d2c8643abf716 Mon Sep 17 00:00:00 2001 From: Massimiliano Pippi Date: Wed, 4 Mar 2020 18:04:13 +0100 Subject: [PATCH 07/15] add generated docs for protobuf --- Taskfile.yml | 13 +- docs/rpc/commands.md | 1476 ++++++++++++++++++++++++++++++++++++++++++ docs/rpc/debug.md | 140 ++++ docs/rpc/monitor.md | 130 ++++ docs/rpc/settings.md | 147 +++++ mkdocs.yml | 5 + 6 files changed, 1907 insertions(+), 4 deletions(-) create mode 100644 docs/rpc/commands.md create mode 100644 docs/rpc/debug.md create mode 100644 docs/rpc/monitor.md create mode 100644 docs/rpc/settings.md diff --git a/Taskfile.yml b/Taskfile.yml index 5dc842fb9b9..94577d3e545 100755 --- a/Taskfile.yml +++ b/Taskfile.yml @@ -9,6 +9,14 @@ tasks: - '{{ default "protoc" .PROTOC_BINARY }} --proto_path=rpc --go_out=plugins=grpc,paths=source_relative:rpc ./rpc/settings/*.proto' - '{{ default "protoc" .PROTOC_BINARY }} --proto_path=rpc --go_out=plugins=grpc,paths=source_relative:rpc ./rpc/debug/*.proto' + protoc:docs: + desc: Generate docs for protobuf definitions + cmds: + - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,commands.md --proto_path=rpc ./rpc/commands/*.proto' + - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,monitor.md --proto_path=rpc ./rpc/monitor/*.proto' + - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,settings.md --proto_path=rpc ./rpc/settings/*.proto' + - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,debug.md --proto_path=rpc ./rpc/debug/*.proto' + build: desc: Build the project cmds: @@ -62,13 +70,11 @@ vars: # all modules of this project except for "legacy/..." module DEFAULT_TARGETS: sh: echo `go list ./... | grep -v legacy | tr '\n' ' '` - # build vars COMMIT: sh: echo ${TRAVIS_COMMIT:-`git log -n 1 --format=%h`} LDFLAGS: > - -ldflags '-X github.com/arduino/arduino-cli/version.commit={{.COMMIT}}' - + -ldflags '-X github.com/arduino/arduino-cli/version.commit={{.COMMIT}}' # test vars GOFLAGS: "-timeout 10m -v -coverpkg=./... -covermode=atomic" TEST_VERSIONSTRING: "0.0.0-test.preview" @@ -76,7 +82,6 @@ vars: TEST_LDFLAGS: > -ldflags '-X github.com/arduino/arduino-cli/version.versionString={{.TEST_VERSIONSTRING}} -X github.com/arduino/arduino-cli/version.commit={{.TEST_COMMIT}}' - # check-lint vars GOLINTBIN: sh: go list -f {{"{{"}}".Target{{"}}"}}" golang.org/x/lint/golint diff --git a/docs/rpc/commands.md b/docs/rpc/commands.md new file mode 100644 index 00000000000..d1f80212653 --- /dev/null +++ b/docs/rpc/commands.md @@ -0,0 +1,1476 @@ +# Protocol Documentation + + +## Table of Contents + +- [commands/board.proto](#commands/board.proto) + - [BoardAttachReq](#cc.arduino.cli.commands.BoardAttachReq) + - [BoardAttachResp](#cc.arduino.cli.commands.BoardAttachResp) + - [BoardDetailsReq](#cc.arduino.cli.commands.BoardDetailsReq) + - [BoardDetailsResp](#cc.arduino.cli.commands.BoardDetailsResp) + - [BoardListAllReq](#cc.arduino.cli.commands.BoardListAllReq) + - [BoardListAllResp](#cc.arduino.cli.commands.BoardListAllResp) + - [BoardListItem](#cc.arduino.cli.commands.BoardListItem) + - [BoardListReq](#cc.arduino.cli.commands.BoardListReq) + - [BoardListResp](#cc.arduino.cli.commands.BoardListResp) + - [ConfigOption](#cc.arduino.cli.commands.ConfigOption) + - [ConfigValue](#cc.arduino.cli.commands.ConfigValue) + - [DetectedPort](#cc.arduino.cli.commands.DetectedPort) + - [RequiredTool](#cc.arduino.cli.commands.RequiredTool) + + + + + +- [commands/commands.proto](#commands/commands.proto) + - [DestroyReq](#cc.arduino.cli.commands.DestroyReq) + - [DestroyResp](#cc.arduino.cli.commands.DestroyResp) + - [InitReq](#cc.arduino.cli.commands.InitReq) + - [InitResp](#cc.arduino.cli.commands.InitResp) + - [RescanReq](#cc.arduino.cli.commands.RescanReq) + - [RescanResp](#cc.arduino.cli.commands.RescanResp) + - [UpdateIndexReq](#cc.arduino.cli.commands.UpdateIndexReq) + - [UpdateIndexResp](#cc.arduino.cli.commands.UpdateIndexResp) + - [UpdateLibrariesIndexReq](#cc.arduino.cli.commands.UpdateLibrariesIndexReq) + - [UpdateLibrariesIndexResp](#cc.arduino.cli.commands.UpdateLibrariesIndexResp) + - [VersionReq](#cc.arduino.cli.commands.VersionReq) + - [VersionResp](#cc.arduino.cli.commands.VersionResp) + + + + - [ArduinoCore](#cc.arduino.cli.commands.ArduinoCore) + + +- [commands/common.proto](#commands/common.proto) + - [DownloadProgress](#cc.arduino.cli.commands.DownloadProgress) + - [Instance](#cc.arduino.cli.commands.Instance) + - [TaskProgress](#cc.arduino.cli.commands.TaskProgress) + + + + + +- [commands/compile.proto](#commands/compile.proto) + - [CompileReq](#cc.arduino.cli.commands.CompileReq) + - [CompileResp](#cc.arduino.cli.commands.CompileResp) + + + + + +- [commands/core.proto](#commands/core.proto) + - [Board](#cc.arduino.cli.commands.Board) + - [Platform](#cc.arduino.cli.commands.Platform) + - [PlatformDownloadReq](#cc.arduino.cli.commands.PlatformDownloadReq) + - [PlatformDownloadResp](#cc.arduino.cli.commands.PlatformDownloadResp) + - [PlatformInstallReq](#cc.arduino.cli.commands.PlatformInstallReq) + - [PlatformInstallResp](#cc.arduino.cli.commands.PlatformInstallResp) + - [PlatformListReq](#cc.arduino.cli.commands.PlatformListReq) + - [PlatformListResp](#cc.arduino.cli.commands.PlatformListResp) + - [PlatformSearchReq](#cc.arduino.cli.commands.PlatformSearchReq) + - [PlatformSearchResp](#cc.arduino.cli.commands.PlatformSearchResp) + - [PlatformUninstallReq](#cc.arduino.cli.commands.PlatformUninstallReq) + - [PlatformUninstallResp](#cc.arduino.cli.commands.PlatformUninstallResp) + - [PlatformUpgradeReq](#cc.arduino.cli.commands.PlatformUpgradeReq) + - [PlatformUpgradeResp](#cc.arduino.cli.commands.PlatformUpgradeResp) + + + + + +- [commands/lib.proto](#commands/lib.proto) + - [DownloadResource](#cc.arduino.cli.commands.DownloadResource) + - [InstalledLibrary](#cc.arduino.cli.commands.InstalledLibrary) + - [Library](#cc.arduino.cli.commands.Library) + - [Library.PropertiesEntry](#cc.arduino.cli.commands.Library.PropertiesEntry) + - [LibraryDependency](#cc.arduino.cli.commands.LibraryDependency) + - [LibraryDependencyStatus](#cc.arduino.cli.commands.LibraryDependencyStatus) + - [LibraryDownloadReq](#cc.arduino.cli.commands.LibraryDownloadReq) + - [LibraryDownloadResp](#cc.arduino.cli.commands.LibraryDownloadResp) + - [LibraryInstallReq](#cc.arduino.cli.commands.LibraryInstallReq) + - [LibraryInstallResp](#cc.arduino.cli.commands.LibraryInstallResp) + - [LibraryListReq](#cc.arduino.cli.commands.LibraryListReq) + - [LibraryListResp](#cc.arduino.cli.commands.LibraryListResp) + - [LibraryRelease](#cc.arduino.cli.commands.LibraryRelease) + - [LibraryResolveDependenciesReq](#cc.arduino.cli.commands.LibraryResolveDependenciesReq) + - [LibraryResolveDependenciesResp](#cc.arduino.cli.commands.LibraryResolveDependenciesResp) + - [LibrarySearchReq](#cc.arduino.cli.commands.LibrarySearchReq) + - [LibrarySearchResp](#cc.arduino.cli.commands.LibrarySearchResp) + - [LibraryUninstallReq](#cc.arduino.cli.commands.LibraryUninstallReq) + - [LibraryUninstallResp](#cc.arduino.cli.commands.LibraryUninstallResp) + - [LibraryUpgradeAllReq](#cc.arduino.cli.commands.LibraryUpgradeAllReq) + - [LibraryUpgradeAllResp](#cc.arduino.cli.commands.LibraryUpgradeAllResp) + - [SearchedLibrary](#cc.arduino.cli.commands.SearchedLibrary) + - [SearchedLibrary.ReleasesEntry](#cc.arduino.cli.commands.SearchedLibrary.ReleasesEntry) + + - [LibraryLayout](#cc.arduino.cli.commands.LibraryLayout) + - [LibraryLocation](#cc.arduino.cli.commands.LibraryLocation) + + + + +- [commands/upload.proto](#commands/upload.proto) + - [UploadReq](#cc.arduino.cli.commands.UploadReq) + - [UploadResp](#cc.arduino.cli.commands.UploadResp) + + + + + +- [Scalar Value Types](#scalar-value-types) + + + + +

Top

+ +## commands/board.proto + + + + + +### BoardAttachReq + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | +| board_uri | [string](#string) | | | +| sketch_path | [string](#string) | | | +| search_timeout | [string](#string) | | | + + + + + + + + +### BoardAttachResp + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| task_progress | [TaskProgress](#cc.arduino.cli.commands.TaskProgress) | | | + + + + + + + + +### BoardDetailsReq + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | +| fqbn | [string](#string) | | | + + + + + + + + +### BoardDetailsResp + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | | +| config_options | [ConfigOption](#cc.arduino.cli.commands.ConfigOption) | repeated | | +| required_tools | [RequiredTool](#cc.arduino.cli.commands.RequiredTool) | repeated | | + + + + + + + + +### BoardListAllReq + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | +| search_args | [string](#string) | repeated | | + + + + + + + + +### BoardListAllResp + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| boards | [BoardListItem](#cc.arduino.cli.commands.BoardListItem) | repeated | | + + + + + + + + +### BoardListItem + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | | +| FQBN | [string](#string) | | | + + + + + + + + +### BoardListReq + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | + + + + + + + + +### BoardListResp + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| ports | [DetectedPort](#cc.arduino.cli.commands.DetectedPort) | repeated | | + + + + + + + + +### ConfigOption + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| option | [string](#string) | | | +| option_label | [string](#string) | | | +| values | [ConfigValue](#cc.arduino.cli.commands.ConfigValue) | repeated | | + + + + + + + + +### ConfigValue + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| value | [string](#string) | | | +| value_label | [string](#string) | | | +| selected | [bool](#bool) | | | + + + + + + + + +### DetectedPort + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| address | [string](#string) | | | +| protocol | [string](#string) | | | +| protocol_label | [string](#string) | | | +| boards | [BoardListItem](#cc.arduino.cli.commands.BoardListItem) | repeated | | + + + + + + + + +### RequiredTool + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | | +| version | [string](#string) | | | +| packager | [string](#string) | | | + + + + + + + + + + + + + + + + +

Top

+ +## commands/commands.proto + + + + + +### DestroyReq + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | + + + + + + + + +### DestroyResp + + + + + + + + + +### InitReq + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| library_manager_only | [bool](#bool) | | | + + + + + + + + +### InitResp + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | +| platforms_index_errors | [string](#string) | repeated | | +| libraries_index_error | [string](#string) | | | +| download_progress | [DownloadProgress](#cc.arduino.cli.commands.DownloadProgress) | | | +| task_progress | [TaskProgress](#cc.arduino.cli.commands.TaskProgress) | | | + + + + + + + + +### RescanReq + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | + + + + + + + + +### RescanResp + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| platforms_index_errors | [string](#string) | repeated | | +| libraries_index_error | [string](#string) | | | + + + + + + + + +### UpdateIndexReq + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | + + + + + + + + +### UpdateIndexResp + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| download_progress | [DownloadProgress](#cc.arduino.cli.commands.DownloadProgress) | | | + + + + + + + + +### UpdateLibrariesIndexReq + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | + + + + + + + + +### UpdateLibrariesIndexResp + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| download_progress | [DownloadProgress](#cc.arduino.cli.commands.DownloadProgress) | | | + + + + + + + + +### VersionReq + + + + + + + + + +### VersionResp + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| version | [string](#string) | | | + + + + + + + + + + + + + + +### ArduinoCore +The main Arduino Platform Service + +BOOTSTRAP COMMANDS +------------------- + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Init | [InitReq](#cc.arduino.cli.commands.InitReq) | [InitResp](#cc.arduino.cli.commands.InitResp) stream | Start a new instance of the Arduino Core Service | +| Destroy | [DestroyReq](#cc.arduino.cli.commands.DestroyReq) | [DestroyResp](#cc.arduino.cli.commands.DestroyResp) | Destroy an instance of the Arduino Core Service | +| Rescan | [RescanReq](#cc.arduino.cli.commands.RescanReq) | [RescanResp](#cc.arduino.cli.commands.RescanResp) | Rescan instance of the Arduino Core Service | +| UpdateIndex | [UpdateIndexReq](#cc.arduino.cli.commands.UpdateIndexReq) | [UpdateIndexResp](#cc.arduino.cli.commands.UpdateIndexResp) stream | Update package index of the Arduino Core Service | +| UpdateLibrariesIndex | [UpdateLibrariesIndexReq](#cc.arduino.cli.commands.UpdateLibrariesIndexReq) | [UpdateLibrariesIndexResp](#cc.arduino.cli.commands.UpdateLibrariesIndexResp) stream | Update libraries index | +| Version | [VersionReq](#cc.arduino.cli.commands.VersionReq) | [VersionResp](#cc.arduino.cli.commands.VersionResp) | | +| BoardDetails | [BoardDetailsReq](#cc.arduino.cli.commands.BoardDetailsReq) | [BoardDetailsResp](#cc.arduino.cli.commands.BoardDetailsResp) | Requests details about a board | +| BoardAttach | [BoardAttachReq](#cc.arduino.cli.commands.BoardAttachReq) | [BoardAttachResp](#cc.arduino.cli.commands.BoardAttachResp) stream | | +| BoardList | [BoardListReq](#cc.arduino.cli.commands.BoardListReq) | [BoardListResp](#cc.arduino.cli.commands.BoardListResp) | | +| BoardListAll | [BoardListAllReq](#cc.arduino.cli.commands.BoardListAllReq) | [BoardListAllResp](#cc.arduino.cli.commands.BoardListAllResp) | | +| Compile | [CompileReq](#cc.arduino.cli.commands.CompileReq) | [CompileResp](#cc.arduino.cli.commands.CompileResp) stream | | +| PlatformInstall | [PlatformInstallReq](#cc.arduino.cli.commands.PlatformInstallReq) | [PlatformInstallResp](#cc.arduino.cli.commands.PlatformInstallResp) stream | | +| PlatformDownload | [PlatformDownloadReq](#cc.arduino.cli.commands.PlatformDownloadReq) | [PlatformDownloadResp](#cc.arduino.cli.commands.PlatformDownloadResp) stream | | +| PlatformUninstall | [PlatformUninstallReq](#cc.arduino.cli.commands.PlatformUninstallReq) | [PlatformUninstallResp](#cc.arduino.cli.commands.PlatformUninstallResp) stream | | +| PlatformUpgrade | [PlatformUpgradeReq](#cc.arduino.cli.commands.PlatformUpgradeReq) | [PlatformUpgradeResp](#cc.arduino.cli.commands.PlatformUpgradeResp) stream | | +| Upload | [UploadReq](#cc.arduino.cli.commands.UploadReq) | [UploadResp](#cc.arduino.cli.commands.UploadResp) stream | | +| PlatformSearch | [PlatformSearchReq](#cc.arduino.cli.commands.PlatformSearchReq) | [PlatformSearchResp](#cc.arduino.cli.commands.PlatformSearchResp) | | +| PlatformList | [PlatformListReq](#cc.arduino.cli.commands.PlatformListReq) | [PlatformListResp](#cc.arduino.cli.commands.PlatformListResp) | | +| LibraryDownload | [LibraryDownloadReq](#cc.arduino.cli.commands.LibraryDownloadReq) | [LibraryDownloadResp](#cc.arduino.cli.commands.LibraryDownloadResp) stream | | +| LibraryInstall | [LibraryInstallReq](#cc.arduino.cli.commands.LibraryInstallReq) | [LibraryInstallResp](#cc.arduino.cli.commands.LibraryInstallResp) stream | | +| LibraryUninstall | [LibraryUninstallReq](#cc.arduino.cli.commands.LibraryUninstallReq) | [LibraryUninstallResp](#cc.arduino.cli.commands.LibraryUninstallResp) stream | | +| LibraryUpgradeAll | [LibraryUpgradeAllReq](#cc.arduino.cli.commands.LibraryUpgradeAllReq) | [LibraryUpgradeAllResp](#cc.arduino.cli.commands.LibraryUpgradeAllResp) stream | | +| LibraryResolveDependencies | [LibraryResolveDependenciesReq](#cc.arduino.cli.commands.LibraryResolveDependenciesReq) | [LibraryResolveDependenciesResp](#cc.arduino.cli.commands.LibraryResolveDependenciesResp) | | +| LibrarySearch | [LibrarySearchReq](#cc.arduino.cli.commands.LibrarySearchReq) | [LibrarySearchResp](#cc.arduino.cli.commands.LibrarySearchResp) | | +| LibraryList | [LibraryListReq](#cc.arduino.cli.commands.LibraryListReq) | [LibraryListResp](#cc.arduino.cli.commands.LibraryListResp) | | + + + + + + +

Top

+ +## commands/common.proto + + + + + +### DownloadProgress + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| url | [string](#string) | | | +| file | [string](#string) | | | +| total_size | [int64](#int64) | | | +| downloaded | [int64](#int64) | | | +| completed | [bool](#bool) | | | + + + + + + + + +### Instance + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [int32](#int32) | | | + + + + + + + + +### TaskProgress + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | | +| message | [string](#string) | | | +| completed | [bool](#bool) | | | + + + + + + + + + + + + + + + + +

Top

+ +## commands/compile.proto + + + + + +### CompileReq + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | +| fqbn | [string](#string) | | Fully Qualified Board Name, e.g.: arduino:avr:uno. | +| sketchPath | [string](#string) | | | +| showProperties | [bool](#bool) | | Show all build preferences used instead of compiling. | +| preprocess | [bool](#bool) | | Print preprocessed code to stdout. | +| buildCachePath | [string](#string) | | Builds of 'core.a' are saved into this path to be cached and reused. | +| buildPath | [string](#string) | | Path where to save compiled files. | +| buildProperties | [string](#string) | repeated | List of custom build properties separated by commas. Or can be used multiple times for multiple properties. | +| warnings | [string](#string) | | Used to tell gcc which warning level to use. | +| verbose | [bool](#bool) | | Turns on verbose mode. | +| quiet | [bool](#bool) | | Suppresses almost every output. | +| vidPid | [string](#string) | | VID/PID specific build properties. | +| exportFile | [string](#string) | | The compiled binary is written to this file | +| jobs | [int32](#int32) | | The max number of concurrent compiler instances to run (as make -jx) | +| libraries | [string](#string) | repeated | List of custom libraries paths separated by commas. Or can be used multiple times for multiple libraries paths. | +| optimizeForDebug | [bool](#bool) | | Optimize compile output for debug, not for release | + + + + + + + + +### CompileResp + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| out_stream | [bytes](#bytes) | | | +| err_stream | [bytes](#bytes) | | | + + + + + + + + + + + + + + + + +

Top

+ +## commands/core.proto + + + + + +### Board + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | | +| fqbn | [string](#string) | | | + + + + + + + + +### Platform + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| ID | [string](#string) | | | +| Installed | [string](#string) | | | +| Latest | [string](#string) | | | +| Name | [string](#string) | | | +| Maintainer | [string](#string) | | | +| Website | [string](#string) | | | +| Email | [string](#string) | | | +| Boards | [Board](#cc.arduino.cli.commands.Board) | repeated | | + + + + + + + + +### PlatformDownloadReq + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | +| platform_package | [string](#string) | | | +| architecture | [string](#string) | | | +| version | [string](#string) | | | + + + + + + + + +### PlatformDownloadResp + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| progress | [DownloadProgress](#cc.arduino.cli.commands.DownloadProgress) | | | + + + + + + + + +### PlatformInstallReq + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | +| platform_package | [string](#string) | | | +| architecture | [string](#string) | | | +| version | [string](#string) | | | + + + + + + + + +### PlatformInstallResp + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| progress | [DownloadProgress](#cc.arduino.cli.commands.DownloadProgress) | | | +| task_progress | [TaskProgress](#cc.arduino.cli.commands.TaskProgress) | | | + + + + + + + + +### PlatformListReq + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | +| updatable_only | [bool](#bool) | | | + + + + + + + + +### PlatformListResp + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| installed_platform | [Platform](#cc.arduino.cli.commands.Platform) | repeated | | + + + + + + + + +### PlatformSearchReq + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | +| search_args | [string](#string) | | | +| all_versions | [bool](#bool) | | | + + + + + + + + +### PlatformSearchResp + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| search_output | [Platform](#cc.arduino.cli.commands.Platform) | repeated | | + + + + + + + + +### PlatformUninstallReq + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | +| platform_package | [string](#string) | | | +| architecture | [string](#string) | | | + + + + + + + + +### PlatformUninstallResp + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| task_progress | [TaskProgress](#cc.arduino.cli.commands.TaskProgress) | | | + + + + + + + + +### PlatformUpgradeReq + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | +| platform_package | [string](#string) | | | +| architecture | [string](#string) | | | + + + + + + + + +### PlatformUpgradeResp + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| progress | [DownloadProgress](#cc.arduino.cli.commands.DownloadProgress) | | | +| task_progress | [TaskProgress](#cc.arduino.cli.commands.TaskProgress) | | | + + + + + + + + + + + + + + + + +

Top

+ +## commands/lib.proto + + + + + +### DownloadResource + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| url | [string](#string) | | | +| archivefilename | [string](#string) | | | +| checksum | [string](#string) | | | +| size | [int64](#int64) | | | +| cachepath | [string](#string) | | | + + + + + + + + +### InstalledLibrary + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| library | [Library](#cc.arduino.cli.commands.Library) | | | +| release | [LibraryRelease](#cc.arduino.cli.commands.LibraryRelease) | | | + + + + + + + + +### Library + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | | +| author | [string](#string) | | | +| maintainer | [string](#string) | | | +| sentence | [string](#string) | | | +| paragraph | [string](#string) | | | +| website | [string](#string) | | | +| category | [string](#string) | | | +| architectures | [string](#string) | repeated | | +| types | [string](#string) | repeated | | +| install_dir | [string](#string) | | | +| source_dir | [string](#string) | | | +| utility_dir | [string](#string) | | | +| location | [string](#string) | | | +| container_platform | [string](#string) | | | +| layout | [string](#string) | | | +| real_name | [string](#string) | | | +| dot_a_linkage | [bool](#bool) | | | +| precompiled | [bool](#bool) | | | +| ld_flags | [string](#string) | | | +| is_legacy | [bool](#bool) | | | +| version | [string](#string) | | | +| license | [string](#string) | | | +| properties | [Library.PropertiesEntry](#cc.arduino.cli.commands.Library.PropertiesEntry) | repeated | | + + + + + + + + +### Library.PropertiesEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + + + + + + +### LibraryDependency + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | | +| version_constraint | [string](#string) | | | + + + + + + + + +### LibraryDependencyStatus + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | | +| versionRequired | [string](#string) | | | +| versionInstalled | [string](#string) | | | + + + + + + + + +### LibraryDownloadReq + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | +| name | [string](#string) | | | +| version | [string](#string) | | | + + + + + + + + +### LibraryDownloadResp + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| progress | [DownloadProgress](#cc.arduino.cli.commands.DownloadProgress) | | | + + + + + + + + +### LibraryInstallReq + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | +| name | [string](#string) | | | +| version | [string](#string) | | | + + + + + + + + +### LibraryInstallResp + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| progress | [DownloadProgress](#cc.arduino.cli.commands.DownloadProgress) | | | +| task_progress | [TaskProgress](#cc.arduino.cli.commands.TaskProgress) | | | + + + + + + + + +### LibraryListReq + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | +| all | [bool](#bool) | | | +| updatable | [bool](#bool) | | | + + + + + + + + +### LibraryListResp + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| installed_library | [InstalledLibrary](#cc.arduino.cli.commands.InstalledLibrary) | repeated | | + + + + + + + + +### LibraryRelease + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| author | [string](#string) | | | +| version | [string](#string) | | | +| maintainer | [string](#string) | | | +| sentence | [string](#string) | | | +| paragraph | [string](#string) | | | +| website | [string](#string) | | | +| category | [string](#string) | | | +| architectures | [string](#string) | repeated | | +| types | [string](#string) | repeated | | +| resources | [DownloadResource](#cc.arduino.cli.commands.DownloadResource) | | | +| license | [string](#string) | | | +| provides_includes | [string](#string) | repeated | | +| dependencies | [LibraryDependency](#cc.arduino.cli.commands.LibraryDependency) | repeated | | + + + + + + + + +### LibraryResolveDependenciesReq + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | +| name | [string](#string) | | | +| version | [string](#string) | | | + + + + + + + + +### LibraryResolveDependenciesResp + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| dependencies | [LibraryDependencyStatus](#cc.arduino.cli.commands.LibraryDependencyStatus) | repeated | | + + + + + + + + +### LibrarySearchReq + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | +| query | [string](#string) | | | + + + + + + + + +### LibrarySearchResp + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| libraries | [SearchedLibrary](#cc.arduino.cli.commands.SearchedLibrary) | repeated | | + + + + + + + + +### LibraryUninstallReq + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | +| name | [string](#string) | | | +| version | [string](#string) | | | + + + + + + + + +### LibraryUninstallResp + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| task_progress | [TaskProgress](#cc.arduino.cli.commands.TaskProgress) | | | + + + + + + + + +### LibraryUpgradeAllReq + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | + + + + + + + + +### LibraryUpgradeAllResp + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| progress | [DownloadProgress](#cc.arduino.cli.commands.DownloadProgress) | | | +| task_progress | [TaskProgress](#cc.arduino.cli.commands.TaskProgress) | | | + + + + + + + + +### SearchedLibrary + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | | +| releases | [SearchedLibrary.ReleasesEntry](#cc.arduino.cli.commands.SearchedLibrary.ReleasesEntry) | repeated | | +| latest | [LibraryRelease](#cc.arduino.cli.commands.LibraryRelease) | | | + + + + + + + + +### SearchedLibrary.ReleasesEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [LibraryRelease](#cc.arduino.cli.commands.LibraryRelease) | | | + + + + + + + + + + +### LibraryLayout + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| flat_layout | 0 | | +| recursive_layout | 1 | | + + + + + +### LibraryLocation + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| ide_builtin | 0 | | +| platform_builtin | 1 | | +| referenced_platform_builtin | 2 | | +| sketchbook | 3 | | + + + + + + + + + + + +

Top

+ +## commands/upload.proto + + + + + +### UploadReq + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | +| fqbn | [string](#string) | | | +| sketch_path | [string](#string) | | | +| port | [string](#string) | | | +| verbose | [bool](#bool) | | | +| verify | [bool](#bool) | | | +| import_file | [string](#string) | | | + + + + + + + + +### UploadResp + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| out_stream | [bytes](#bytes) | | | +| err_stream | [bytes](#bytes) | | | + + + + + + + + + + + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | float | float | Float | +| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/docs/rpc/debug.md b/docs/rpc/debug.md new file mode 100644 index 00000000000..2728ea9dd4a --- /dev/null +++ b/docs/rpc/debug.md @@ -0,0 +1,140 @@ +# Protocol Documentation + + +## Table of Contents + +- [debug/debug.proto](#debug/debug.proto) + - [DebugConfigReq](#cc.arduino.cli.debug.DebugConfigReq) + - [DebugReq](#cc.arduino.cli.debug.DebugReq) + - [DebugResp](#cc.arduino.cli.debug.DebugResp) + - [Instance](#cc.arduino.cli.debug.Instance) + + + + - [Debug](#cc.arduino.cli.debug.Debug) + + +- [Scalar Value Types](#scalar-value-types) + + + + +

Top

+ +## debug/debug.proto + + + + + +### DebugConfigReq + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| instance | [Instance](#cc.arduino.cli.debug.Instance) | | | +| fqbn | [string](#string) | | | +| sketch_path | [string](#string) | | | +| port | [string](#string) | | | +| verbose | [bool](#bool) | | | +| import_file | [string](#string) | | | + + + + + + + + +### DebugReq +The top-level message sent by the client for the `Debug` method. +Multiple `DebugReq` messages can be sent but the first message +must contain a `DebugReq` message to initialize the debug session. +All subsequent messages must contain bytes to be sent to the debug session +and must not contain a `DebugReq` message. + +Content must be either a debug session config or data to be sent. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| debugReq | [DebugConfigReq](#cc.arduino.cli.debug.DebugConfigReq) | | Provides information to the debug that specifies which is the target. The first `StreamingOpenReq` message must contain a `DebugReq` message. | +| data | [bytes](#bytes) | | The data to be sent to the target being monitored. | +| send_interrupt | [bool](#bool) | | Set this to true to send and Interrupt signal to the debugger process | + + + + + + + + +### DebugResp + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| data | [bytes](#bytes) | | | +| error | [string](#string) | | | + + + + + + + + +### Instance +TODO remove this in next proto refactoring because is a duplicate from commands/common.proto + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [int32](#int32) | | | + + + + + + + + + + + + + + +### Debug +Service that abstract a debug Session usage + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Debug | [DebugReq](#cc.arduino.cli.debug.DebugReq) stream | [DebugResp](#cc.arduino.cli.debug.DebugResp) stream | | + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | float | float | Float | +| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/docs/rpc/monitor.md b/docs/rpc/monitor.md new file mode 100644 index 00000000000..7c040b808d4 --- /dev/null +++ b/docs/rpc/monitor.md @@ -0,0 +1,130 @@ +# Protocol Documentation + + +## Table of Contents + +- [monitor/monitor.proto](#monitor/monitor.proto) + - [MonitorConfig](#cc.arduino.cli.monitor.MonitorConfig) + - [StreamingOpenReq](#cc.arduino.cli.monitor.StreamingOpenReq) + - [StreamingOpenResp](#cc.arduino.cli.monitor.StreamingOpenResp) + + - [MonitorConfig.TargetType](#cc.arduino.cli.monitor.MonitorConfig.TargetType) + + + - [Monitor](#cc.arduino.cli.monitor.Monitor) + + +- [Scalar Value Types](#scalar-value-types) + + + + +

Top

+ +## monitor/monitor.proto + + + + + +### MonitorConfig +Tells the monitor which target to open and provides additional parameters +that might be needed to configure the target or the monitor itself. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| target | [string](#string) | | | +| type | [MonitorConfig.TargetType](#cc.arduino.cli.monitor.MonitorConfig.TargetType) | | | +| additionalConfig | [google.protobuf.Struct](#google.protobuf.Struct) | | | + + + + + + + + +### StreamingOpenReq +The top-level message sent by the client for the `StreamingOpen` method. +Multiple `StreamingOpenReq` messages can be sent but the first message +must contain a `monitor_config` message to initialize the monitor target. +All subsequent messages must contain bytes to be sent to the target +and must not contain a `monitor_config` message. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| monitorConfig | [MonitorConfig](#cc.arduino.cli.monitor.MonitorConfig) | | Provides information to the monitor that specifies which is the target. The first `StreamingOpenReq` message must contain a `monitor_config` message. | +| data | [bytes](#bytes) | | The data to be sent to the target being monitored. | + + + + + + + + +### StreamingOpenResp + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| data | [bytes](#bytes) | | | + + + + + + + + + + +### MonitorConfig.TargetType + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| SERIAL | 0 | | + + + + + + + + + +### Monitor +Service that abstract a Monitor usage + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| StreamingOpen | [StreamingOpenReq](#cc.arduino.cli.monitor.StreamingOpenReq) stream | [StreamingOpenResp](#cc.arduino.cli.monitor.StreamingOpenResp) stream | | + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | float | float | Float | +| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/docs/rpc/settings.md b/docs/rpc/settings.md new file mode 100644 index 00000000000..b226682cf7b --- /dev/null +++ b/docs/rpc/settings.md @@ -0,0 +1,147 @@ +# Protocol Documentation + + +## Table of Contents + +- [settings/settings.proto](#settings/settings.proto) + - [GetAllRequest](#cc.arduino.cli.settings.GetAllRequest) + - [GetValueRequest](#cc.arduino.cli.settings.GetValueRequest) + - [MergeResponse](#cc.arduino.cli.settings.MergeResponse) + - [RawData](#cc.arduino.cli.settings.RawData) + - [SetValueResponse](#cc.arduino.cli.settings.SetValueResponse) + - [Value](#cc.arduino.cli.settings.Value) + + + + - [Settings](#cc.arduino.cli.settings.Settings) + + +- [Scalar Value Types](#scalar-value-types) + + + + +

Top

+ +## settings/settings.proto + + + + + +### GetAllRequest + + + + + + + + + +### GetValueRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | + + + + + + + + +### MergeResponse + + + + + + + + + +### RawData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| jsonData | [string](#string) | | | + + + + + + + + +### SetValueResponse + + + + + + + + + +### Value + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| jsonData | [string](#string) | | | + + + + + + + + + + + + + + +### Settings + + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| GetAll | [GetAllRequest](#cc.arduino.cli.settings.GetAllRequest) | [RawData](#cc.arduino.cli.settings.RawData) | | +| Merge | [RawData](#cc.arduino.cli.settings.RawData) | [MergeResponse](#cc.arduino.cli.settings.MergeResponse) | | +| GetValue | [GetValueRequest](#cc.arduino.cli.settings.GetValueRequest) | [Value](#cc.arduino.cli.settings.Value) | | +| SetValue | [Value](#cc.arduino.cli.settings.Value) | [SetValueResponse](#cc.arduino.cli.settings.SetValueResponse) | | + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | float | float | Float | +| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/mkdocs.yml b/mkdocs.yml index 663957b2752..5ade2d39195 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -94,3 +94,8 @@ nav: - sketch new: commands/arduino-cli_sketch_new.md - upload: commands/arduino-cli_upload.md - version: commands/arduino-cli_version.md + - gRPC services: + - commands: rpc/commands.md + - monitor: rpc/monitor.md + - settings: rpc/settings.md + - debug: rpc/debug.md From aedf953849fe137337d326adfb49225883215f35 Mon Sep 17 00:00:00 2001 From: Massimiliano Pippi Date: Wed, 4 Mar 2020 18:13:24 +0100 Subject: [PATCH 08/15] added arduino logo --- docs/img/icon_mac_light.png | Bin 0 -> 846 bytes mkdocs.yml | 1 + 2 files changed, 1 insertion(+) create mode 100644 docs/img/icon_mac_light.png diff --git a/docs/img/icon_mac_light.png b/docs/img/icon_mac_light.png new file mode 100644 index 0000000000000000000000000000000000000000..b06aa7f3f04c01097fb11eed4c61f96af3b13a4a GIT binary patch literal 846 zcmV-U1F`&xP)NE@NG}7!E*KHy1Ir?a5Wzydg^+#?T89>=d+xp3y+#WTd++tw-#UA(z0NxDk15Di zQ4&EAg!2|)3y=VcfEi#Icpe17LP0#0bWGBKvePR`9r*wZ$HS6RT0G5%j)Z$H1^kiz zo?c2Sj&mZ20WSl_fSNo-a2luwrh*_)tOL%=Pr$mxBxw#b15^QXVKQSG{M(yff`>qD zp1}difusjd7yCmhJauLY!L)f=*y7`kp(u>Kq_#BRH-Kh~T|Lka3})DS80Y{RfC``q z=mzE^FM1~3@%Ou98kDp$L#XzpIoh@?SG(8gj;B)yX~gliO1dv;%$&OHWSgALHplOj zlr)fQdD+W!{KRv7Mll7_x&F| zfTZ@whI5j-BsE$?QEe5lFGFr5t%ItytK1;ztcA_f#kh~r_ee%B&&SBo$z|xoFJ Date: Wed, 4 Mar 2020 18:13:49 +0100 Subject: [PATCH 09/15] temporarily re-enable publishing --- .github/workflows/docs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index c4177dcf2ad..67dd3cae711 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -55,7 +55,7 @@ jobs: - name: Deploy # publish docs only when PR is merged - if: github.event.pull_request.merged == 'true' + # if: github.event.pull_request.merged == 'true' uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} From 5f9d4d8ba22e8d74c4c7555a4e0393ae6bb8dbe2 Mon Sep 17 00:00:00 2001 From: Massimiliano Pippi Date: Wed, 4 Mar 2020 18:17:46 +0100 Subject: [PATCH 10/15] automate grpc docs generation --- .github/workflows/docs.yaml | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 67dd3cae711..ce0be20838e 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -24,8 +24,15 @@ jobs: with: go-version: '1.13' - - name: Print Go version - run: go version + - name: Install Go dependencies + run: | + go version + go get -u github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc + + - name: Install protoc compiler + uses: arduino/setup-protoc@v1.1.0 + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} - name: Setup Python uses: actions/setup-python@v1 @@ -41,7 +48,7 @@ jobs: restore-keys: | ${{ runner.os }}-pip- - - name: Install dependencies + - name: Install Python dependencies run: | python3 -m pip install --upgrade pip python3 -m pip install -r ./requirements_docs.txt @@ -50,6 +57,9 @@ jobs: working-directory: docsgen run: task gen:commands + - name: Generate protocol buffers reference + run: task protoc:docs + - name: Build docs website run: mkdocs build -s From b52aa9a9ce48dc218e361f47a963533474376f8c Mon Sep 17 00:00:00 2001 From: Massimiliano Pippi Date: Wed, 4 Mar 2020 18:25:36 +0100 Subject: [PATCH 11/15] do not track generated files --- docs/commands/.gitkeep | 0 docs/commands/arduino-cli.md | 42 - docs/commands/arduino-cli_board.md | 45 - docs/commands/arduino-cli_board_attach.md | 44 - docs/commands/arduino-cli_board_details.md | 41 - docs/commands/arduino-cli_board_list.md | 42 - docs/commands/arduino-cli_board_listall.md | 43 - docs/commands/arduino-cli_cache.md | 41 - docs/commands/arduino-cli_cache_clean.md | 41 - docs/commands/arduino-cli_compile.md | 56 - docs/commands/arduino-cli_config.md | 39 - docs/commands/arduino-cli_config_dump.md | 41 - docs/commands/arduino-cli_config_init.md | 43 - docs/commands/arduino-cli_core.md | 44 - docs/commands/arduino-cli_core_download.md | 42 - docs/commands/arduino-cli_core_install.md | 45 - docs/commands/arduino-cli_core_list.md | 42 - docs/commands/arduino-cli_core_search.md | 42 - docs/commands/arduino-cli_core_uninstall.md | 42 - .../commands/arduino-cli_core_update-index.md | 41 - docs/commands/arduino-cli_core_upgrade.md | 45 - docs/commands/arduino-cli_daemon.md | 43 - docs/commands/arduino-cli_debug.md | 44 - docs/commands/arduino-cli_lib.md | 46 - docs/commands/arduino-cli_lib_deps.md | 42 - docs/commands/arduino-cli_lib_download.md | 42 - docs/commands/arduino-cli_lib_install.md | 43 - docs/commands/arduino-cli_lib_list.md | 43 - docs/commands/arduino-cli_lib_search.md | 42 - docs/commands/arduino-cli_lib_uninstall.md | 41 - docs/commands/arduino-cli_lib_update-index.md | 41 - docs/commands/arduino-cli_lib_upgrade.md | 43 - docs/commands/arduino-cli_sketch.md | 38 - docs/commands/arduino-cli_sketch_new.md | 41 - docs/commands/arduino-cli_upload.md | 45 - docs/commands/arduino-cli_version.md | 41 - docs/rpc/.gitkeep | 0 docs/rpc/commands.md | 1476 ----------------- docs/rpc/debug.md | 140 -- docs/rpc/monitor.md | 130 -- docs/rpc/settings.md | 147 -- 41 files changed, 3389 deletions(-) create mode 100644 docs/commands/.gitkeep delete mode 100644 docs/commands/arduino-cli.md delete mode 100644 docs/commands/arduino-cli_board.md delete mode 100644 docs/commands/arduino-cli_board_attach.md delete mode 100644 docs/commands/arduino-cli_board_details.md delete mode 100644 docs/commands/arduino-cli_board_list.md delete mode 100644 docs/commands/arduino-cli_board_listall.md delete mode 100644 docs/commands/arduino-cli_cache.md delete mode 100644 docs/commands/arduino-cli_cache_clean.md delete mode 100644 docs/commands/arduino-cli_compile.md delete mode 100644 docs/commands/arduino-cli_config.md delete mode 100644 docs/commands/arduino-cli_config_dump.md delete mode 100644 docs/commands/arduino-cli_config_init.md delete mode 100644 docs/commands/arduino-cli_core.md delete mode 100644 docs/commands/arduino-cli_core_download.md delete mode 100644 docs/commands/arduino-cli_core_install.md delete mode 100644 docs/commands/arduino-cli_core_list.md delete mode 100644 docs/commands/arduino-cli_core_search.md delete mode 100644 docs/commands/arduino-cli_core_uninstall.md delete mode 100644 docs/commands/arduino-cli_core_update-index.md delete mode 100644 docs/commands/arduino-cli_core_upgrade.md delete mode 100644 docs/commands/arduino-cli_daemon.md delete mode 100644 docs/commands/arduino-cli_debug.md delete mode 100644 docs/commands/arduino-cli_lib.md delete mode 100644 docs/commands/arduino-cli_lib_deps.md delete mode 100644 docs/commands/arduino-cli_lib_download.md delete mode 100644 docs/commands/arduino-cli_lib_install.md delete mode 100644 docs/commands/arduino-cli_lib_list.md delete mode 100644 docs/commands/arduino-cli_lib_search.md delete mode 100644 docs/commands/arduino-cli_lib_uninstall.md delete mode 100644 docs/commands/arduino-cli_lib_update-index.md delete mode 100644 docs/commands/arduino-cli_lib_upgrade.md delete mode 100644 docs/commands/arduino-cli_sketch.md delete mode 100644 docs/commands/arduino-cli_sketch_new.md delete mode 100644 docs/commands/arduino-cli_upload.md delete mode 100644 docs/commands/arduino-cli_version.md create mode 100644 docs/rpc/.gitkeep delete mode 100644 docs/rpc/commands.md delete mode 100644 docs/rpc/debug.md delete mode 100644 docs/rpc/monitor.md delete mode 100644 docs/rpc/settings.md diff --git a/docs/commands/.gitkeep b/docs/commands/.gitkeep new file mode 100644 index 00000000000..e69de29bb2d diff --git a/docs/commands/arduino-cli.md b/docs/commands/arduino-cli.md deleted file mode 100644 index db4ff914ded..00000000000 --- a/docs/commands/arduino-cli.md +++ /dev/null @@ -1,42 +0,0 @@ -## arduino-cli - -Arduino CLI. - -### Synopsis - -Arduino Command Line Interface (arduino-cli). - -### Examples - -``` - arduino-cli [flags...] -``` - -### Options - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - -h, --help help for arduino-cli - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli board](arduino-cli_board.md) - Arduino board commands. -* [arduino-cli cache](arduino-cli_cache.md) - Arduino cache commands. -* [arduino-cli compile](arduino-cli_compile.md) - Compiles Arduino sketches. -* [arduino-cli config](arduino-cli_config.md) - Arduino Configuration Commands. -* [arduino-cli core](arduino-cli_core.md) - Arduino Core operations. -* [arduino-cli daemon](arduino-cli_daemon.md) - Run as a daemon on port -* [arduino-cli debug](arduino-cli_debug.md) - Debug Arduino sketches. -* [arduino-cli lib](arduino-cli_lib.md) - Arduino commands about libraries. -* [arduino-cli sketch](arduino-cli_sketch.md) - Arduino CLI Sketch Commands. -* [arduino-cli upload](arduino-cli_upload.md) - Upload Arduino sketches. -* [arduino-cli version](arduino-cli_version.md) - Shows version number of arduino CLI. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_board.md b/docs/commands/arduino-cli_board.md deleted file mode 100644 index 64e8af380dd..00000000000 --- a/docs/commands/arduino-cli_board.md +++ /dev/null @@ -1,45 +0,0 @@ -## arduino-cli board - -Arduino board commands. - -### Synopsis - -Arduino board commands. - -### Examples - -``` - # Lists all connected boards. - arduino-cli board list - - # Attaches a sketch to a board. - arduino-cli board attach serial:///dev/tty/ACM0 mySketch -``` - -### Options - -``` - -h, --help help for board -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli](arduino-cli.md) - Arduino CLI. -* [arduino-cli board attach](arduino-cli_board_attach.md) - Attaches a sketch to a board. -* [arduino-cli board details](arduino-cli_board_details.md) - Print details about a board. -* [arduino-cli board list](arduino-cli_board_list.md) - List connected boards. -* [arduino-cli board listall](arduino-cli_board_listall.md) - List all known boards and their corresponding FQBN. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_board_attach.md b/docs/commands/arduino-cli_board_attach.md deleted file mode 100644 index 960eced1063..00000000000 --- a/docs/commands/arduino-cli_board_attach.md +++ /dev/null @@ -1,44 +0,0 @@ -## arduino-cli board attach - -Attaches a sketch to a board. - -### Synopsis - -Attaches a sketch to a board. - -``` -arduino-cli board attach | [sketchPath] [flags] -``` - -### Examples - -``` - arduino-cli board attach serial:///dev/tty/ACM0 - arduino-cli board attach serial:///dev/tty/ACM0 HelloWorld - arduino-cli board attach arduino:samd:mkr1000 -``` - -### Options - -``` - -h, --help help for attach - --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") -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli board](arduino-cli_board.md) - Arduino board commands. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_board_details.md b/docs/commands/arduino-cli_board_details.md deleted file mode 100644 index 5e25f3637d6..00000000000 --- a/docs/commands/arduino-cli_board_details.md +++ /dev/null @@ -1,41 +0,0 @@ -## arduino-cli board details - -Print details about a board. - -### Synopsis - -Show information about a board, in particular if the board has options to be specified in the FQBN. - -``` -arduino-cli board details [flags] -``` - -### Examples - -``` - arduino-cli board details arduino:avr:nano -``` - -### Options - -``` - -h, --help help for details -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli board](arduino-cli_board.md) - Arduino board commands. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_board_list.md b/docs/commands/arduino-cli_board_list.md deleted file mode 100644 index ca2b4841f60..00000000000 --- a/docs/commands/arduino-cli_board_list.md +++ /dev/null @@ -1,42 +0,0 @@ -## arduino-cli board list - -List connected boards. - -### Synopsis - -Detects and displays a list of connected boards to the current computer. - -``` -arduino-cli board list [flags] -``` - -### Examples - -``` - arduino-cli board list --timeout 10s -``` - -### Options - -``` - -h, --help help for list - --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") -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli board](arduino-cli_board.md) - Arduino board commands. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_board_listall.md b/docs/commands/arduino-cli_board_listall.md deleted file mode 100644 index 758924b7356..00000000000 --- a/docs/commands/arduino-cli_board_listall.md +++ /dev/null @@ -1,43 +0,0 @@ -## arduino-cli board listall - -List all known boards and their corresponding FQBN. - -### Synopsis - -List all boards that have the support platform installed. You can search -for a specific board if you specify the board name - -``` -arduino-cli board listall [boardname] [flags] -``` - -### Examples - -``` - arduino-cli board listall - arduino-cli board listall zero -``` - -### Options - -``` - -h, --help help for listall -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli board](arduino-cli_board.md) - Arduino board commands. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_cache.md b/docs/commands/arduino-cli_cache.md deleted file mode 100644 index bbd18ac8d26..00000000000 --- a/docs/commands/arduino-cli_cache.md +++ /dev/null @@ -1,41 +0,0 @@ -## arduino-cli cache - -Arduino cache commands. - -### Synopsis - -Arduino cache commands. - -### Examples - -``` -# Clean caches. - arduino-cli cache clean - - -``` - -### Options - -``` - -h, --help help for cache -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli](arduino-cli.md) - Arduino CLI. -* [arduino-cli cache clean](arduino-cli_cache_clean.md) - Clean arduino cache. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_cache_clean.md b/docs/commands/arduino-cli_cache_clean.md deleted file mode 100644 index bc17c92c755..00000000000 --- a/docs/commands/arduino-cli_cache_clean.md +++ /dev/null @@ -1,41 +0,0 @@ -## arduino-cli cache clean - -Clean arduino cache. - -### Synopsis - -Clean the files i.e. `~/arduino15/staging` in Linux. - -``` -arduino-cli cache clean [flags] -``` - -### Examples - -``` - arduino-cli cache clean -``` - -### Options - -``` - -h, --help help for clean -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli cache](arduino-cli_cache.md) - Arduino cache commands. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_compile.md b/docs/commands/arduino-cli_compile.md deleted file mode 100644 index 5e4a75a659b..00000000000 --- a/docs/commands/arduino-cli_compile.md +++ /dev/null @@ -1,56 +0,0 @@ -## arduino-cli compile - -Compiles Arduino sketches. - -### Synopsis - -Compiles Arduino sketches. - -``` -arduino-cli compile [flags] -``` - -### Examples - -``` - arduino-cli compile -b arduino:avr:uno /home/user/Arduino/MySketch -``` - -### Options - -``` - --build-cache-path string Builds of 'core.a' are saved into this path to be cached and reused. - --build-path string Path where to save compiled files. If omitted, a directory will be created in the default temporary path of your OS. - --build-properties strings List of custom build properties separated by commas. Or can be used multiple times for multiple properties. - -b, --fqbn string Fully Qualified Board Name, e.g.: arduino:avr:uno - -h, --help help for compile - --libraries strings List of custom libraries paths separated by commas. Or can be used multiple times for multiple libraries paths. - --optimize-for-debug Optional, optimize compile output for debug, not for release. - -o, --output string Filename of the compile output. - -p, --port string Upload port, e.g.: COM10 or /dev/ttyACM0 - --preprocess Print preprocessed code to stdout instead of compiling. - --quiet Optional, supresses almost every output. - --show-properties Show all build properties used instead of compiling. - -u, --upload Upload the binary after the compilation. - -t, --verify Verify uploaded binary after the upload. - --vid-pid string When specified, VID/PID specific build properties are used, if boards supports them. - --warnings string Optional, can be "none", "default", "more" and "all". Defaults to "none". Used to tell gcc which warning level to use (-W flag). (default "none") -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli](arduino-cli.md) - Arduino CLI. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_config.md b/docs/commands/arduino-cli_config.md deleted file mode 100644 index b868b8291a5..00000000000 --- a/docs/commands/arduino-cli_config.md +++ /dev/null @@ -1,39 +0,0 @@ -## arduino-cli config - -Arduino Configuration Commands. - -### Synopsis - -Arduino Configuration Commands. - -### Examples - -``` - arduino-cli config init -``` - -### Options - -``` - -h, --help help for config -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli](arduino-cli.md) - Arduino CLI. -* [arduino-cli config dump](arduino-cli_config_dump.md) - Prints the current configuration -* [arduino-cli config init](arduino-cli_config_init.md) - Initializes a new configuration file into the default location. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_config_dump.md b/docs/commands/arduino-cli_config_dump.md deleted file mode 100644 index 7994f765034..00000000000 --- a/docs/commands/arduino-cli_config_dump.md +++ /dev/null @@ -1,41 +0,0 @@ -## arduino-cli config dump - -Prints the current configuration - -### Synopsis - -Prints the current configuration. - -``` -arduino-cli config dump [flags] -``` - -### Examples - -``` - arduino-cli config dump -``` - -### Options - -``` - -h, --help help for dump -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli config](arduino-cli_config.md) - Arduino Configuration Commands. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_config_init.md b/docs/commands/arduino-cli_config_init.md deleted file mode 100644 index c00e6e11a49..00000000000 --- a/docs/commands/arduino-cli_config_init.md +++ /dev/null @@ -1,43 +0,0 @@ -## arduino-cli config init - -Initializes a new configuration file into the default location. - -### Synopsis - -Initializes a new configuration file into the default location ($EXE_DIR/cli-config.yml). - -``` -arduino-cli config init [flags] -``` - -### Examples - -``` - # Creates a default configuration file into the default location. - arduino-cli config init -``` - -### Options - -``` - --dest-dir string Sets where to save the configuration file. - -h, --help help for init -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli config](arduino-cli_config.md) - Arduino Configuration Commands. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_core.md b/docs/commands/arduino-cli_core.md deleted file mode 100644 index def75810113..00000000000 --- a/docs/commands/arduino-cli_core.md +++ /dev/null @@ -1,44 +0,0 @@ -## arduino-cli core - -Arduino Core operations. - -### Synopsis - -Arduino Core operations. - -### Examples - -``` - arduino-cli core update-index -``` - -### Options - -``` - -h, --help help for core -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli](arduino-cli.md) - Arduino CLI. -* [arduino-cli core download](arduino-cli_core_download.md) - Downloads one or more cores and corresponding tool dependencies. -* [arduino-cli core install](arduino-cli_core_install.md) - Installs one or more cores and corresponding tool dependencies. -* [arduino-cli core list](arduino-cli_core_list.md) - Shows the list of installed platforms. -* [arduino-cli core search](arduino-cli_core_search.md) - Search for a core in the package index. -* [arduino-cli core uninstall](arduino-cli_core_uninstall.md) - Uninstalls one or more cores and corresponding tool dependencies if no more used. -* [arduino-cli core update-index](arduino-cli_core_update-index.md) - Updates the index of cores. -* [arduino-cli core upgrade](arduino-cli_core_upgrade.md) - Upgrades one or all installed platforms to the latest version. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_core_download.md b/docs/commands/arduino-cli_core_download.md deleted file mode 100644 index d7da1d4a4dd..00000000000 --- a/docs/commands/arduino-cli_core_download.md +++ /dev/null @@ -1,42 +0,0 @@ -## arduino-cli core download - -Downloads one or more cores and corresponding tool dependencies. - -### Synopsis - -Downloads one or more cores and corresponding tool dependencies. - -``` -arduino-cli core download [PACKAGER:ARCH[=VERSION]](S) [flags] -``` - -### Examples - -``` - arduino-cli core download arduino:samd # to download the latest version of arduino SAMD core. - arduino-cli core download arduino:samd=1.6.9 # for a specific version (in this case 1.6.9). -``` - -### Options - -``` - -h, --help help for download -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli core](arduino-cli_core.md) - Arduino Core operations. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_core_install.md b/docs/commands/arduino-cli_core_install.md deleted file mode 100644 index 5474402194d..00000000000 --- a/docs/commands/arduino-cli_core_install.md +++ /dev/null @@ -1,45 +0,0 @@ -## arduino-cli core install - -Installs one or more cores and corresponding tool dependencies. - -### Synopsis - -Installs one or more cores and corresponding tool dependencies. - -``` -arduino-cli core install PACKAGER:ARCH[@VERSION] ... [flags] -``` - -### Examples - -``` - # download the latest version of arduino SAMD core. - arduino-cli core install arduino:samd - - # download a specific version (in this case 1.6.9). - arduino-cli core install arduino:samd@1.6.9 -``` - -### Options - -``` - -h, --help help for install -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli core](arduino-cli_core.md) - Arduino Core operations. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_core_list.md b/docs/commands/arduino-cli_core_list.md deleted file mode 100644 index 7516632301e..00000000000 --- a/docs/commands/arduino-cli_core_list.md +++ /dev/null @@ -1,42 +0,0 @@ -## arduino-cli core list - -Shows the list of installed platforms. - -### Synopsis - -Shows the list of installed platforms. - -``` -arduino-cli core list [flags] -``` - -### Examples - -``` - arduino-cli core list -``` - -### Options - -``` - -h, --help help for list - --updatable List updatable platforms. -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli core](arduino-cli_core.md) - Arduino Core operations. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_core_search.md b/docs/commands/arduino-cli_core_search.md deleted file mode 100644 index 52fe5b20f42..00000000000 --- a/docs/commands/arduino-cli_core_search.md +++ /dev/null @@ -1,42 +0,0 @@ -## arduino-cli core search - -Search for a core in the package index. - -### Synopsis - -Search for a core in the package index using the specified keywords. - -``` -arduino-cli core search [flags] -``` - -### Examples - -``` - arduino-cli core search MKRZero -a -v -``` - -### Options - -``` - -a, --all Show all available core versions. - -h, --help help for search -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli core](arduino-cli_core.md) - Arduino Core operations. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_core_uninstall.md b/docs/commands/arduino-cli_core_uninstall.md deleted file mode 100644 index 25504841c76..00000000000 --- a/docs/commands/arduino-cli_core_uninstall.md +++ /dev/null @@ -1,42 +0,0 @@ -## arduino-cli core uninstall - -Uninstalls one or more cores and corresponding tool dependencies if no more used. - -### Synopsis - -Uninstalls one or more cores and corresponding tool dependencies if no more used. - -``` -arduino-cli core uninstall PACKAGER:ARCH ... [flags] -``` - -### Examples - -``` - arduino-cli core uninstall arduino:samd - -``` - -### Options - -``` - -h, --help help for uninstall -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli core](arduino-cli_core.md) - Arduino Core operations. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_core_update-index.md b/docs/commands/arduino-cli_core_update-index.md deleted file mode 100644 index 6ec6aa3be58..00000000000 --- a/docs/commands/arduino-cli_core_update-index.md +++ /dev/null @@ -1,41 +0,0 @@ -## arduino-cli core update-index - -Updates the index of cores. - -### Synopsis - -Updates the index of cores to the latest version. - -``` -arduino-cli core update-index [flags] -``` - -### Examples - -``` - arduino-cli core update-index -``` - -### Options - -``` - -h, --help help for update-index -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli core](arduino-cli_core.md) - Arduino Core operations. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_core_upgrade.md b/docs/commands/arduino-cli_core_upgrade.md deleted file mode 100644 index b73598943fb..00000000000 --- a/docs/commands/arduino-cli_core_upgrade.md +++ /dev/null @@ -1,45 +0,0 @@ -## arduino-cli core upgrade - -Upgrades one or all installed platforms to the latest version. - -### Synopsis - -Upgrades one or all installed platforms to the latest version. - -``` -arduino-cli core upgrade [PACKAGER:ARCH] ... [flags] -``` - -### Examples - -``` - # upgrade everything to the latest version - arduino-cli core upgrade - - # upgrade arduino:samd to the latest version - arduino-cli core upgrade arduino:samd -``` - -### Options - -``` - -h, --help help for upgrade -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli core](arduino-cli_core.md) - Arduino Core operations. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_daemon.md b/docs/commands/arduino-cli_daemon.md deleted file mode 100644 index 9ef28825c0f..00000000000 --- a/docs/commands/arduino-cli_daemon.md +++ /dev/null @@ -1,43 +0,0 @@ -## arduino-cli daemon - -Run as a daemon on port - -### Synopsis - -Running as a daemon the initialization of cores and libraries is done only once. - -``` -arduino-cli daemon [flags] -``` - -### Examples - -``` - arduino-cli daemon -``` - -### Options - -``` - --daemonize Do not terminate daemon process if the parent process dies - -h, --help help for daemon - --port string The TCP port the daemon will listen to -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli](arduino-cli.md) - Arduino CLI. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_debug.md b/docs/commands/arduino-cli_debug.md deleted file mode 100644 index 2069936c534..00000000000 --- a/docs/commands/arduino-cli_debug.md +++ /dev/null @@ -1,44 +0,0 @@ -## arduino-cli debug - -Debug Arduino sketches. - -### Synopsis - -Debug Arduino sketches. (this command opens an interactive gdb session) - -``` -arduino-cli debug [flags] -``` - -### Examples - -``` - arduino-cli debug -b arduino:samd:mkr1000 /home/user/Arduino/MySketch -``` - -### Options - -``` - -b, --fqbn string Fully Qualified Board Name, e.g.: arduino:avr:uno - -h, --help help for debug - -i, --input string Input file to be uploaded for debug. - -p, --port string Upload port, e.g.: COM10 or /dev/ttyACM0 -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli](arduino-cli.md) - Arduino CLI. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_lib.md b/docs/commands/arduino-cli_lib.md deleted file mode 100644 index 42fff47bfea..00000000000 --- a/docs/commands/arduino-cli_lib.md +++ /dev/null @@ -1,46 +0,0 @@ -## arduino-cli lib - -Arduino commands about libraries. - -### Synopsis - -Arduino commands about libraries. - -### Examples - -``` - arduino-cli lib install AudioZero - arduino-cli lib update-index -``` - -### Options - -``` - -h, --help help for lib -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli](arduino-cli.md) - Arduino CLI. -* [arduino-cli lib deps](arduino-cli_lib_deps.md) - Check dependencies status for the specified library. -* [arduino-cli lib download](arduino-cli_lib_download.md) - Downloads one or more libraries without installing them. -* [arduino-cli lib install](arduino-cli_lib_install.md) - Installs one of more specified libraries into the system. -* [arduino-cli lib list](arduino-cli_lib_list.md) - Shows a list of all installed libraries. -* [arduino-cli lib search](arduino-cli_lib_search.md) - Searches for one or more libraries data. -* [arduino-cli lib uninstall](arduino-cli_lib_uninstall.md) - Uninstalls one or more libraries. -* [arduino-cli lib update-index](arduino-cli_lib_update-index.md) - Updates the libraries index. -* [arduino-cli lib upgrade](arduino-cli_lib_upgrade.md) - Upgrades installed libraries. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_lib_deps.md b/docs/commands/arduino-cli_lib_deps.md deleted file mode 100644 index e287fc0de8e..00000000000 --- a/docs/commands/arduino-cli_lib_deps.md +++ /dev/null @@ -1,42 +0,0 @@ -## arduino-cli lib deps - -Check dependencies status for the specified library. - -### Synopsis - -Check dependencies status for the specified library. - -``` -arduino-cli lib deps LIBRARY[@VERSION_NUMBER](S) [flags] -``` - -### Examples - -``` - arduino-cli lib deps AudioZero # for the latest version. - arduino-cli lib deps AudioZero@1.0.0 # for the specific version. -``` - -### Options - -``` - -h, --help help for deps -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli lib](arduino-cli_lib.md) - Arduino commands about libraries. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_lib_download.md b/docs/commands/arduino-cli_lib_download.md deleted file mode 100644 index 50ce9359c72..00000000000 --- a/docs/commands/arduino-cli_lib_download.md +++ /dev/null @@ -1,42 +0,0 @@ -## arduino-cli lib download - -Downloads one or more libraries without installing them. - -### Synopsis - -Downloads one or more libraries without installing them. - -``` -arduino-cli lib download [LIBRARY_NAME(S)] [flags] -``` - -### Examples - -``` - arduino-cli lib download AudioZero # for the latest version. - arduino-cli lib download AudioZero@1.0.0 # for a specific version. -``` - -### Options - -``` - -h, --help help for download -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli lib](arduino-cli_lib.md) - Arduino commands about libraries. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_lib_install.md b/docs/commands/arduino-cli_lib_install.md deleted file mode 100644 index a54ad953ae7..00000000000 --- a/docs/commands/arduino-cli_lib_install.md +++ /dev/null @@ -1,43 +0,0 @@ -## arduino-cli lib install - -Installs one of more specified libraries into the system. - -### Synopsis - -Installs one or more specified libraries into the system. - -``` -arduino-cli lib install LIBRARY[@VERSION_NUMBER](S) [flags] -``` - -### Examples - -``` - arduino-cli lib install AudioZero # for the latest version. - arduino-cli lib install AudioZero@1.0.0 # for the specific version. -``` - -### Options - -``` - -h, --help help for install - --no-deps Do not install dependencies. -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli lib](arduino-cli_lib.md) - Arduino commands about libraries. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_lib_list.md b/docs/commands/arduino-cli_lib_list.md deleted file mode 100644 index 8870c3984c6..00000000000 --- a/docs/commands/arduino-cli_lib_list.md +++ /dev/null @@ -1,43 +0,0 @@ -## arduino-cli lib list - -Shows a list of all installed libraries. - -### Synopsis - -Shows a list of all installed libraries. - -``` -arduino-cli lib list [flags] -``` - -### Examples - -``` - arduino-cli lib list -``` - -### Options - -``` - --all Include built-in libraries (from platforms and IDE) in listing. - -h, --help help for list - --updatable List updatable libraries. -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli lib](arduino-cli_lib.md) - Arduino commands about libraries. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_lib_search.md b/docs/commands/arduino-cli_lib_search.md deleted file mode 100644 index c3f76e49f39..00000000000 --- a/docs/commands/arduino-cli_lib_search.md +++ /dev/null @@ -1,42 +0,0 @@ -## arduino-cli lib search - -Searches for one or more libraries data. - -### Synopsis - -Search for one or more libraries data (case insensitive search). - -``` -arduino-cli lib search [LIBRARY_NAME] [flags] -``` - -### Examples - -``` - arduino-cli lib search audio -``` - -### Options - -``` - -h, --help help for search - --names Show library names only. -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli lib](arduino-cli_lib.md) - Arduino commands about libraries. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_lib_uninstall.md b/docs/commands/arduino-cli_lib_uninstall.md deleted file mode 100644 index 7f528f46092..00000000000 --- a/docs/commands/arduino-cli_lib_uninstall.md +++ /dev/null @@ -1,41 +0,0 @@ -## arduino-cli lib uninstall - -Uninstalls one or more libraries. - -### Synopsis - -Uninstalls one or more libraries. - -``` -arduino-cli lib uninstall LIBRARY_NAME(S) [flags] -``` - -### Examples - -``` - arduino-cli lib uninstall AudioZero -``` - -### Options - -``` - -h, --help help for uninstall -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli lib](arduino-cli_lib.md) - Arduino commands about libraries. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_lib_update-index.md b/docs/commands/arduino-cli_lib_update-index.md deleted file mode 100644 index 227ad1815cd..00000000000 --- a/docs/commands/arduino-cli_lib_update-index.md +++ /dev/null @@ -1,41 +0,0 @@ -## arduino-cli lib update-index - -Updates the libraries index. - -### Synopsis - -Updates the libraries index to the latest version. - -``` -arduino-cli lib update-index [flags] -``` - -### Examples - -``` - arduino-cli lib update-index -``` - -### Options - -``` - -h, --help help for update-index -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli lib](arduino-cli_lib.md) - Arduino commands about libraries. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_lib_upgrade.md b/docs/commands/arduino-cli_lib_upgrade.md deleted file mode 100644 index 4bd3eb27b95..00000000000 --- a/docs/commands/arduino-cli_lib_upgrade.md +++ /dev/null @@ -1,43 +0,0 @@ -## arduino-cli lib upgrade - -Upgrades installed libraries. - -### Synopsis - -This command upgrades an installed library to the latest available version. Multiple libraries can be passed separated by a space. If no arguments are provided, the command will upgrade all the installed libraries where an update is available. - -``` -arduino-cli lib upgrade [flags] -``` - -### Examples - -``` - arduino-cli lib upgrade - arduino-cli lib upgrade Audio - arduino-cli lib upgrade Audio ArduinoJson -``` - -### Options - -``` - -h, --help help for upgrade -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli lib](arduino-cli_lib.md) - Arduino commands about libraries. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_sketch.md b/docs/commands/arduino-cli_sketch.md deleted file mode 100644 index 00360bfff35..00000000000 --- a/docs/commands/arduino-cli_sketch.md +++ /dev/null @@ -1,38 +0,0 @@ -## arduino-cli sketch - -Arduino CLI Sketch Commands. - -### Synopsis - -Arduino CLI Sketch Commands. - -### Examples - -``` - arduino-cli sketch new MySketch -``` - -### Options - -``` - -h, --help help for sketch -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli](arduino-cli.md) - Arduino CLI. -* [arduino-cli sketch new](arduino-cli_sketch_new.md) - Create a new Sketch - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_sketch_new.md b/docs/commands/arduino-cli_sketch_new.md deleted file mode 100644 index 901c46b2b34..00000000000 --- a/docs/commands/arduino-cli_sketch_new.md +++ /dev/null @@ -1,41 +0,0 @@ -## arduino-cli sketch new - -Create a new Sketch - -### Synopsis - -Create a new Sketch - -``` -arduino-cli sketch new [flags] -``` - -### Examples - -``` - arduino-cli sketch new MultiBlinker -``` - -### Options - -``` - -h, --help help for new -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli sketch](arduino-cli_sketch.md) - Arduino CLI Sketch Commands. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_upload.md b/docs/commands/arduino-cli_upload.md deleted file mode 100644 index 524c04f5b18..00000000000 --- a/docs/commands/arduino-cli_upload.md +++ /dev/null @@ -1,45 +0,0 @@ -## arduino-cli upload - -Upload Arduino sketches. - -### Synopsis - -Upload Arduino sketches. - -``` -arduino-cli upload [flags] -``` - -### Examples - -``` - arduino-cli upload /home/user/Arduino/MySketch -``` - -### Options - -``` - -b, --fqbn string Fully Qualified Board Name, e.g.: arduino:avr:uno - -h, --help help for upload - -i, --input string Input file to be uploaded. - -p, --port string Upload port, e.g.: COM10 or /dev/ttyACM0 - -t, --verify Verify uploaded binary after the upload. -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli](arduino-cli.md) - Arduino CLI. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/commands/arduino-cli_version.md b/docs/commands/arduino-cli_version.md deleted file mode 100644 index 3849872b709..00000000000 --- a/docs/commands/arduino-cli_version.md +++ /dev/null @@ -1,41 +0,0 @@ -## arduino-cli version - -Shows version number of arduino CLI. - -### Synopsis - -Shows version number of arduino CLI which is installed on your system. - -``` -arduino-cli version [flags] -``` - -### Examples - -``` - arduino-cli version -``` - -### Options - -``` - -h, --help help for version -``` - -### Options inherited from parent commands - -``` - --additional-urls strings Additional URLs for the board manager. - --config-file string The custom config file (if not specified the default will be used). - --format string The output format, can be [text|json]. (default "text") - --log-file string Path to the file where logs will be written. - --log-format string The output format for the logs, can be [text|json]. - --log-level string Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic - -v, --verbose Print the logs on the standard output. -``` - -### SEE ALSO - -* [arduino-cli](arduino-cli.md) - Arduino CLI. - -###### Auto generated by spf13/cobra on 4-Mar-2020 diff --git a/docs/rpc/.gitkeep b/docs/rpc/.gitkeep new file mode 100644 index 00000000000..e69de29bb2d diff --git a/docs/rpc/commands.md b/docs/rpc/commands.md deleted file mode 100644 index d1f80212653..00000000000 --- a/docs/rpc/commands.md +++ /dev/null @@ -1,1476 +0,0 @@ -# Protocol Documentation - - -## Table of Contents - -- [commands/board.proto](#commands/board.proto) - - [BoardAttachReq](#cc.arduino.cli.commands.BoardAttachReq) - - [BoardAttachResp](#cc.arduino.cli.commands.BoardAttachResp) - - [BoardDetailsReq](#cc.arduino.cli.commands.BoardDetailsReq) - - [BoardDetailsResp](#cc.arduino.cli.commands.BoardDetailsResp) - - [BoardListAllReq](#cc.arduino.cli.commands.BoardListAllReq) - - [BoardListAllResp](#cc.arduino.cli.commands.BoardListAllResp) - - [BoardListItem](#cc.arduino.cli.commands.BoardListItem) - - [BoardListReq](#cc.arduino.cli.commands.BoardListReq) - - [BoardListResp](#cc.arduino.cli.commands.BoardListResp) - - [ConfigOption](#cc.arduino.cli.commands.ConfigOption) - - [ConfigValue](#cc.arduino.cli.commands.ConfigValue) - - [DetectedPort](#cc.arduino.cli.commands.DetectedPort) - - [RequiredTool](#cc.arduino.cli.commands.RequiredTool) - - - - - -- [commands/commands.proto](#commands/commands.proto) - - [DestroyReq](#cc.arduino.cli.commands.DestroyReq) - - [DestroyResp](#cc.arduino.cli.commands.DestroyResp) - - [InitReq](#cc.arduino.cli.commands.InitReq) - - [InitResp](#cc.arduino.cli.commands.InitResp) - - [RescanReq](#cc.arduino.cli.commands.RescanReq) - - [RescanResp](#cc.arduino.cli.commands.RescanResp) - - [UpdateIndexReq](#cc.arduino.cli.commands.UpdateIndexReq) - - [UpdateIndexResp](#cc.arduino.cli.commands.UpdateIndexResp) - - [UpdateLibrariesIndexReq](#cc.arduino.cli.commands.UpdateLibrariesIndexReq) - - [UpdateLibrariesIndexResp](#cc.arduino.cli.commands.UpdateLibrariesIndexResp) - - [VersionReq](#cc.arduino.cli.commands.VersionReq) - - [VersionResp](#cc.arduino.cli.commands.VersionResp) - - - - - [ArduinoCore](#cc.arduino.cli.commands.ArduinoCore) - - -- [commands/common.proto](#commands/common.proto) - - [DownloadProgress](#cc.arduino.cli.commands.DownloadProgress) - - [Instance](#cc.arduino.cli.commands.Instance) - - [TaskProgress](#cc.arduino.cli.commands.TaskProgress) - - - - - -- [commands/compile.proto](#commands/compile.proto) - - [CompileReq](#cc.arduino.cli.commands.CompileReq) - - [CompileResp](#cc.arduino.cli.commands.CompileResp) - - - - - -- [commands/core.proto](#commands/core.proto) - - [Board](#cc.arduino.cli.commands.Board) - - [Platform](#cc.arduino.cli.commands.Platform) - - [PlatformDownloadReq](#cc.arduino.cli.commands.PlatformDownloadReq) - - [PlatformDownloadResp](#cc.arduino.cli.commands.PlatformDownloadResp) - - [PlatformInstallReq](#cc.arduino.cli.commands.PlatformInstallReq) - - [PlatformInstallResp](#cc.arduino.cli.commands.PlatformInstallResp) - - [PlatformListReq](#cc.arduino.cli.commands.PlatformListReq) - - [PlatformListResp](#cc.arduino.cli.commands.PlatformListResp) - - [PlatformSearchReq](#cc.arduino.cli.commands.PlatformSearchReq) - - [PlatformSearchResp](#cc.arduino.cli.commands.PlatformSearchResp) - - [PlatformUninstallReq](#cc.arduino.cli.commands.PlatformUninstallReq) - - [PlatformUninstallResp](#cc.arduino.cli.commands.PlatformUninstallResp) - - [PlatformUpgradeReq](#cc.arduino.cli.commands.PlatformUpgradeReq) - - [PlatformUpgradeResp](#cc.arduino.cli.commands.PlatformUpgradeResp) - - - - - -- [commands/lib.proto](#commands/lib.proto) - - [DownloadResource](#cc.arduino.cli.commands.DownloadResource) - - [InstalledLibrary](#cc.arduino.cli.commands.InstalledLibrary) - - [Library](#cc.arduino.cli.commands.Library) - - [Library.PropertiesEntry](#cc.arduino.cli.commands.Library.PropertiesEntry) - - [LibraryDependency](#cc.arduino.cli.commands.LibraryDependency) - - [LibraryDependencyStatus](#cc.arduino.cli.commands.LibraryDependencyStatus) - - [LibraryDownloadReq](#cc.arduino.cli.commands.LibraryDownloadReq) - - [LibraryDownloadResp](#cc.arduino.cli.commands.LibraryDownloadResp) - - [LibraryInstallReq](#cc.arduino.cli.commands.LibraryInstallReq) - - [LibraryInstallResp](#cc.arduino.cli.commands.LibraryInstallResp) - - [LibraryListReq](#cc.arduino.cli.commands.LibraryListReq) - - [LibraryListResp](#cc.arduino.cli.commands.LibraryListResp) - - [LibraryRelease](#cc.arduino.cli.commands.LibraryRelease) - - [LibraryResolveDependenciesReq](#cc.arduino.cli.commands.LibraryResolveDependenciesReq) - - [LibraryResolveDependenciesResp](#cc.arduino.cli.commands.LibraryResolveDependenciesResp) - - [LibrarySearchReq](#cc.arduino.cli.commands.LibrarySearchReq) - - [LibrarySearchResp](#cc.arduino.cli.commands.LibrarySearchResp) - - [LibraryUninstallReq](#cc.arduino.cli.commands.LibraryUninstallReq) - - [LibraryUninstallResp](#cc.arduino.cli.commands.LibraryUninstallResp) - - [LibraryUpgradeAllReq](#cc.arduino.cli.commands.LibraryUpgradeAllReq) - - [LibraryUpgradeAllResp](#cc.arduino.cli.commands.LibraryUpgradeAllResp) - - [SearchedLibrary](#cc.arduino.cli.commands.SearchedLibrary) - - [SearchedLibrary.ReleasesEntry](#cc.arduino.cli.commands.SearchedLibrary.ReleasesEntry) - - - [LibraryLayout](#cc.arduino.cli.commands.LibraryLayout) - - [LibraryLocation](#cc.arduino.cli.commands.LibraryLocation) - - - - -- [commands/upload.proto](#commands/upload.proto) - - [UploadReq](#cc.arduino.cli.commands.UploadReq) - - [UploadResp](#cc.arduino.cli.commands.UploadResp) - - - - - -- [Scalar Value Types](#scalar-value-types) - - - - -

Top

- -## commands/board.proto - - - - - -### BoardAttachReq - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | -| board_uri | [string](#string) | | | -| sketch_path | [string](#string) | | | -| search_timeout | [string](#string) | | | - - - - - - - - -### BoardAttachResp - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| task_progress | [TaskProgress](#cc.arduino.cli.commands.TaskProgress) | | | - - - - - - - - -### BoardDetailsReq - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | -| fqbn | [string](#string) | | | - - - - - - - - -### BoardDetailsResp - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| name | [string](#string) | | | -| config_options | [ConfigOption](#cc.arduino.cli.commands.ConfigOption) | repeated | | -| required_tools | [RequiredTool](#cc.arduino.cli.commands.RequiredTool) | repeated | | - - - - - - - - -### BoardListAllReq - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | -| search_args | [string](#string) | repeated | | - - - - - - - - -### BoardListAllResp - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| boards | [BoardListItem](#cc.arduino.cli.commands.BoardListItem) | repeated | | - - - - - - - - -### BoardListItem - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| name | [string](#string) | | | -| FQBN | [string](#string) | | | - - - - - - - - -### BoardListReq - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | - - - - - - - - -### BoardListResp - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| ports | [DetectedPort](#cc.arduino.cli.commands.DetectedPort) | repeated | | - - - - - - - - -### ConfigOption - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| option | [string](#string) | | | -| option_label | [string](#string) | | | -| values | [ConfigValue](#cc.arduino.cli.commands.ConfigValue) | repeated | | - - - - - - - - -### ConfigValue - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| value | [string](#string) | | | -| value_label | [string](#string) | | | -| selected | [bool](#bool) | | | - - - - - - - - -### DetectedPort - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| address | [string](#string) | | | -| protocol | [string](#string) | | | -| protocol_label | [string](#string) | | | -| boards | [BoardListItem](#cc.arduino.cli.commands.BoardListItem) | repeated | | - - - - - - - - -### RequiredTool - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| name | [string](#string) | | | -| version | [string](#string) | | | -| packager | [string](#string) | | | - - - - - - - - - - - - - - - - -

Top

- -## commands/commands.proto - - - - - -### DestroyReq - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | - - - - - - - - -### DestroyResp - - - - - - - - - -### InitReq - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| library_manager_only | [bool](#bool) | | | - - - - - - - - -### InitResp - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | -| platforms_index_errors | [string](#string) | repeated | | -| libraries_index_error | [string](#string) | | | -| download_progress | [DownloadProgress](#cc.arduino.cli.commands.DownloadProgress) | | | -| task_progress | [TaskProgress](#cc.arduino.cli.commands.TaskProgress) | | | - - - - - - - - -### RescanReq - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | - - - - - - - - -### RescanResp - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| platforms_index_errors | [string](#string) | repeated | | -| libraries_index_error | [string](#string) | | | - - - - - - - - -### UpdateIndexReq - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | - - - - - - - - -### UpdateIndexResp - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| download_progress | [DownloadProgress](#cc.arduino.cli.commands.DownloadProgress) | | | - - - - - - - - -### UpdateLibrariesIndexReq - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | - - - - - - - - -### UpdateLibrariesIndexResp - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| download_progress | [DownloadProgress](#cc.arduino.cli.commands.DownloadProgress) | | | - - - - - - - - -### VersionReq - - - - - - - - - -### VersionResp - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| version | [string](#string) | | | - - - - - - - - - - - - - - -### ArduinoCore -The main Arduino Platform Service - -BOOTSTRAP COMMANDS -------------------- - -| Method Name | Request Type | Response Type | Description | -| ----------- | ------------ | ------------- | ------------| -| Init | [InitReq](#cc.arduino.cli.commands.InitReq) | [InitResp](#cc.arduino.cli.commands.InitResp) stream | Start a new instance of the Arduino Core Service | -| Destroy | [DestroyReq](#cc.arduino.cli.commands.DestroyReq) | [DestroyResp](#cc.arduino.cli.commands.DestroyResp) | Destroy an instance of the Arduino Core Service | -| Rescan | [RescanReq](#cc.arduino.cli.commands.RescanReq) | [RescanResp](#cc.arduino.cli.commands.RescanResp) | Rescan instance of the Arduino Core Service | -| UpdateIndex | [UpdateIndexReq](#cc.arduino.cli.commands.UpdateIndexReq) | [UpdateIndexResp](#cc.arduino.cli.commands.UpdateIndexResp) stream | Update package index of the Arduino Core Service | -| UpdateLibrariesIndex | [UpdateLibrariesIndexReq](#cc.arduino.cli.commands.UpdateLibrariesIndexReq) | [UpdateLibrariesIndexResp](#cc.arduino.cli.commands.UpdateLibrariesIndexResp) stream | Update libraries index | -| Version | [VersionReq](#cc.arduino.cli.commands.VersionReq) | [VersionResp](#cc.arduino.cli.commands.VersionResp) | | -| BoardDetails | [BoardDetailsReq](#cc.arduino.cli.commands.BoardDetailsReq) | [BoardDetailsResp](#cc.arduino.cli.commands.BoardDetailsResp) | Requests details about a board | -| BoardAttach | [BoardAttachReq](#cc.arduino.cli.commands.BoardAttachReq) | [BoardAttachResp](#cc.arduino.cli.commands.BoardAttachResp) stream | | -| BoardList | [BoardListReq](#cc.arduino.cli.commands.BoardListReq) | [BoardListResp](#cc.arduino.cli.commands.BoardListResp) | | -| BoardListAll | [BoardListAllReq](#cc.arduino.cli.commands.BoardListAllReq) | [BoardListAllResp](#cc.arduino.cli.commands.BoardListAllResp) | | -| Compile | [CompileReq](#cc.arduino.cli.commands.CompileReq) | [CompileResp](#cc.arduino.cli.commands.CompileResp) stream | | -| PlatformInstall | [PlatformInstallReq](#cc.arduino.cli.commands.PlatformInstallReq) | [PlatformInstallResp](#cc.arduino.cli.commands.PlatformInstallResp) stream | | -| PlatformDownload | [PlatformDownloadReq](#cc.arduino.cli.commands.PlatformDownloadReq) | [PlatformDownloadResp](#cc.arduino.cli.commands.PlatformDownloadResp) stream | | -| PlatformUninstall | [PlatformUninstallReq](#cc.arduino.cli.commands.PlatformUninstallReq) | [PlatformUninstallResp](#cc.arduino.cli.commands.PlatformUninstallResp) stream | | -| PlatformUpgrade | [PlatformUpgradeReq](#cc.arduino.cli.commands.PlatformUpgradeReq) | [PlatformUpgradeResp](#cc.arduino.cli.commands.PlatformUpgradeResp) stream | | -| Upload | [UploadReq](#cc.arduino.cli.commands.UploadReq) | [UploadResp](#cc.arduino.cli.commands.UploadResp) stream | | -| PlatformSearch | [PlatformSearchReq](#cc.arduino.cli.commands.PlatformSearchReq) | [PlatformSearchResp](#cc.arduino.cli.commands.PlatformSearchResp) | | -| PlatformList | [PlatformListReq](#cc.arduino.cli.commands.PlatformListReq) | [PlatformListResp](#cc.arduino.cli.commands.PlatformListResp) | | -| LibraryDownload | [LibraryDownloadReq](#cc.arduino.cli.commands.LibraryDownloadReq) | [LibraryDownloadResp](#cc.arduino.cli.commands.LibraryDownloadResp) stream | | -| LibraryInstall | [LibraryInstallReq](#cc.arduino.cli.commands.LibraryInstallReq) | [LibraryInstallResp](#cc.arduino.cli.commands.LibraryInstallResp) stream | | -| LibraryUninstall | [LibraryUninstallReq](#cc.arduino.cli.commands.LibraryUninstallReq) | [LibraryUninstallResp](#cc.arduino.cli.commands.LibraryUninstallResp) stream | | -| LibraryUpgradeAll | [LibraryUpgradeAllReq](#cc.arduino.cli.commands.LibraryUpgradeAllReq) | [LibraryUpgradeAllResp](#cc.arduino.cli.commands.LibraryUpgradeAllResp) stream | | -| LibraryResolveDependencies | [LibraryResolveDependenciesReq](#cc.arduino.cli.commands.LibraryResolveDependenciesReq) | [LibraryResolveDependenciesResp](#cc.arduino.cli.commands.LibraryResolveDependenciesResp) | | -| LibrarySearch | [LibrarySearchReq](#cc.arduino.cli.commands.LibrarySearchReq) | [LibrarySearchResp](#cc.arduino.cli.commands.LibrarySearchResp) | | -| LibraryList | [LibraryListReq](#cc.arduino.cli.commands.LibraryListReq) | [LibraryListResp](#cc.arduino.cli.commands.LibraryListResp) | | - - - - - - -

Top

- -## commands/common.proto - - - - - -### DownloadProgress - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| url | [string](#string) | | | -| file | [string](#string) | | | -| total_size | [int64](#int64) | | | -| downloaded | [int64](#int64) | | | -| completed | [bool](#bool) | | | - - - - - - - - -### Instance - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| id | [int32](#int32) | | | - - - - - - - - -### TaskProgress - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| name | [string](#string) | | | -| message | [string](#string) | | | -| completed | [bool](#bool) | | | - - - - - - - - - - - - - - - - -

Top

- -## commands/compile.proto - - - - - -### CompileReq - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | -| fqbn | [string](#string) | | Fully Qualified Board Name, e.g.: arduino:avr:uno. | -| sketchPath | [string](#string) | | | -| showProperties | [bool](#bool) | | Show all build preferences used instead of compiling. | -| preprocess | [bool](#bool) | | Print preprocessed code to stdout. | -| buildCachePath | [string](#string) | | Builds of 'core.a' are saved into this path to be cached and reused. | -| buildPath | [string](#string) | | Path where to save compiled files. | -| buildProperties | [string](#string) | repeated | List of custom build properties separated by commas. Or can be used multiple times for multiple properties. | -| warnings | [string](#string) | | Used to tell gcc which warning level to use. | -| verbose | [bool](#bool) | | Turns on verbose mode. | -| quiet | [bool](#bool) | | Suppresses almost every output. | -| vidPid | [string](#string) | | VID/PID specific build properties. | -| exportFile | [string](#string) | | The compiled binary is written to this file | -| jobs | [int32](#int32) | | The max number of concurrent compiler instances to run (as make -jx) | -| libraries | [string](#string) | repeated | List of custom libraries paths separated by commas. Or can be used multiple times for multiple libraries paths. | -| optimizeForDebug | [bool](#bool) | | Optimize compile output for debug, not for release | - - - - - - - - -### CompileResp - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| out_stream | [bytes](#bytes) | | | -| err_stream | [bytes](#bytes) | | | - - - - - - - - - - - - - - - - -

Top

- -## commands/core.proto - - - - - -### Board - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| name | [string](#string) | | | -| fqbn | [string](#string) | | | - - - - - - - - -### Platform - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| ID | [string](#string) | | | -| Installed | [string](#string) | | | -| Latest | [string](#string) | | | -| Name | [string](#string) | | | -| Maintainer | [string](#string) | | | -| Website | [string](#string) | | | -| Email | [string](#string) | | | -| Boards | [Board](#cc.arduino.cli.commands.Board) | repeated | | - - - - - - - - -### PlatformDownloadReq - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | -| platform_package | [string](#string) | | | -| architecture | [string](#string) | | | -| version | [string](#string) | | | - - - - - - - - -### PlatformDownloadResp - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| progress | [DownloadProgress](#cc.arduino.cli.commands.DownloadProgress) | | | - - - - - - - - -### PlatformInstallReq - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | -| platform_package | [string](#string) | | | -| architecture | [string](#string) | | | -| version | [string](#string) | | | - - - - - - - - -### PlatformInstallResp - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| progress | [DownloadProgress](#cc.arduino.cli.commands.DownloadProgress) | | | -| task_progress | [TaskProgress](#cc.arduino.cli.commands.TaskProgress) | | | - - - - - - - - -### PlatformListReq - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | -| updatable_only | [bool](#bool) | | | - - - - - - - - -### PlatformListResp - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| installed_platform | [Platform](#cc.arduino.cli.commands.Platform) | repeated | | - - - - - - - - -### PlatformSearchReq - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | -| search_args | [string](#string) | | | -| all_versions | [bool](#bool) | | | - - - - - - - - -### PlatformSearchResp - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| search_output | [Platform](#cc.arduino.cli.commands.Platform) | repeated | | - - - - - - - - -### PlatformUninstallReq - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | -| platform_package | [string](#string) | | | -| architecture | [string](#string) | | | - - - - - - - - -### PlatformUninstallResp - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| task_progress | [TaskProgress](#cc.arduino.cli.commands.TaskProgress) | | | - - - - - - - - -### PlatformUpgradeReq - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | -| platform_package | [string](#string) | | | -| architecture | [string](#string) | | | - - - - - - - - -### PlatformUpgradeResp - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| progress | [DownloadProgress](#cc.arduino.cli.commands.DownloadProgress) | | | -| task_progress | [TaskProgress](#cc.arduino.cli.commands.TaskProgress) | | | - - - - - - - - - - - - - - - - -

Top

- -## commands/lib.proto - - - - - -### DownloadResource - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| url | [string](#string) | | | -| archivefilename | [string](#string) | | | -| checksum | [string](#string) | | | -| size | [int64](#int64) | | | -| cachepath | [string](#string) | | | - - - - - - - - -### InstalledLibrary - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| library | [Library](#cc.arduino.cli.commands.Library) | | | -| release | [LibraryRelease](#cc.arduino.cli.commands.LibraryRelease) | | | - - - - - - - - -### Library - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| name | [string](#string) | | | -| author | [string](#string) | | | -| maintainer | [string](#string) | | | -| sentence | [string](#string) | | | -| paragraph | [string](#string) | | | -| website | [string](#string) | | | -| category | [string](#string) | | | -| architectures | [string](#string) | repeated | | -| types | [string](#string) | repeated | | -| install_dir | [string](#string) | | | -| source_dir | [string](#string) | | | -| utility_dir | [string](#string) | | | -| location | [string](#string) | | | -| container_platform | [string](#string) | | | -| layout | [string](#string) | | | -| real_name | [string](#string) | | | -| dot_a_linkage | [bool](#bool) | | | -| precompiled | [bool](#bool) | | | -| ld_flags | [string](#string) | | | -| is_legacy | [bool](#bool) | | | -| version | [string](#string) | | | -| license | [string](#string) | | | -| properties | [Library.PropertiesEntry](#cc.arduino.cli.commands.Library.PropertiesEntry) | repeated | | - - - - - - - - -### Library.PropertiesEntry - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| key | [string](#string) | | | -| value | [string](#string) | | | - - - - - - - - -### LibraryDependency - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| name | [string](#string) | | | -| version_constraint | [string](#string) | | | - - - - - - - - -### LibraryDependencyStatus - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| name | [string](#string) | | | -| versionRequired | [string](#string) | | | -| versionInstalled | [string](#string) | | | - - - - - - - - -### LibraryDownloadReq - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | -| name | [string](#string) | | | -| version | [string](#string) | | | - - - - - - - - -### LibraryDownloadResp - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| progress | [DownloadProgress](#cc.arduino.cli.commands.DownloadProgress) | | | - - - - - - - - -### LibraryInstallReq - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | -| name | [string](#string) | | | -| version | [string](#string) | | | - - - - - - - - -### LibraryInstallResp - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| progress | [DownloadProgress](#cc.arduino.cli.commands.DownloadProgress) | | | -| task_progress | [TaskProgress](#cc.arduino.cli.commands.TaskProgress) | | | - - - - - - - - -### LibraryListReq - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | -| all | [bool](#bool) | | | -| updatable | [bool](#bool) | | | - - - - - - - - -### LibraryListResp - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| installed_library | [InstalledLibrary](#cc.arduino.cli.commands.InstalledLibrary) | repeated | | - - - - - - - - -### LibraryRelease - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| author | [string](#string) | | | -| version | [string](#string) | | | -| maintainer | [string](#string) | | | -| sentence | [string](#string) | | | -| paragraph | [string](#string) | | | -| website | [string](#string) | | | -| category | [string](#string) | | | -| architectures | [string](#string) | repeated | | -| types | [string](#string) | repeated | | -| resources | [DownloadResource](#cc.arduino.cli.commands.DownloadResource) | | | -| license | [string](#string) | | | -| provides_includes | [string](#string) | repeated | | -| dependencies | [LibraryDependency](#cc.arduino.cli.commands.LibraryDependency) | repeated | | - - - - - - - - -### LibraryResolveDependenciesReq - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | -| name | [string](#string) | | | -| version | [string](#string) | | | - - - - - - - - -### LibraryResolveDependenciesResp - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| dependencies | [LibraryDependencyStatus](#cc.arduino.cli.commands.LibraryDependencyStatus) | repeated | | - - - - - - - - -### LibrarySearchReq - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | -| query | [string](#string) | | | - - - - - - - - -### LibrarySearchResp - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| libraries | [SearchedLibrary](#cc.arduino.cli.commands.SearchedLibrary) | repeated | | - - - - - - - - -### LibraryUninstallReq - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | -| name | [string](#string) | | | -| version | [string](#string) | | | - - - - - - - - -### LibraryUninstallResp - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| task_progress | [TaskProgress](#cc.arduino.cli.commands.TaskProgress) | | | - - - - - - - - -### LibraryUpgradeAllReq - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | - - - - - - - - -### LibraryUpgradeAllResp - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| progress | [DownloadProgress](#cc.arduino.cli.commands.DownloadProgress) | | | -| task_progress | [TaskProgress](#cc.arduino.cli.commands.TaskProgress) | | | - - - - - - - - -### SearchedLibrary - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| name | [string](#string) | | | -| releases | [SearchedLibrary.ReleasesEntry](#cc.arduino.cli.commands.SearchedLibrary.ReleasesEntry) | repeated | | -| latest | [LibraryRelease](#cc.arduino.cli.commands.LibraryRelease) | | | - - - - - - - - -### SearchedLibrary.ReleasesEntry - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| key | [string](#string) | | | -| value | [LibraryRelease](#cc.arduino.cli.commands.LibraryRelease) | | | - - - - - - - - - - -### LibraryLayout - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| flat_layout | 0 | | -| recursive_layout | 1 | | - - - - - -### LibraryLocation - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| ide_builtin | 0 | | -| platform_builtin | 1 | | -| referenced_platform_builtin | 2 | | -| sketchbook | 3 | | - - - - - - - - - - - -

Top

- -## commands/upload.proto - - - - - -### UploadReq - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| instance | [Instance](#cc.arduino.cli.commands.Instance) | | | -| fqbn | [string](#string) | | | -| sketch_path | [string](#string) | | | -| port | [string](#string) | | | -| verbose | [bool](#bool) | | | -| verify | [bool](#bool) | | | -| import_file | [string](#string) | | | - - - - - - - - -### UploadResp - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| out_stream | [bytes](#bytes) | | | -| err_stream | [bytes](#bytes) | | | - - - - - - - - - - - - - - - -## Scalar Value Types - -| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | -| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | -| double | | double | double | float | float64 | double | float | Float | -| float | | float | float | float | float32 | float | float | Float | -| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | -| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum | -| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | -| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | -| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | -| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | -| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | -| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | -| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | -| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | -| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | -| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | -| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | - diff --git a/docs/rpc/debug.md b/docs/rpc/debug.md deleted file mode 100644 index 2728ea9dd4a..00000000000 --- a/docs/rpc/debug.md +++ /dev/null @@ -1,140 +0,0 @@ -# Protocol Documentation - - -## Table of Contents - -- [debug/debug.proto](#debug/debug.proto) - - [DebugConfigReq](#cc.arduino.cli.debug.DebugConfigReq) - - [DebugReq](#cc.arduino.cli.debug.DebugReq) - - [DebugResp](#cc.arduino.cli.debug.DebugResp) - - [Instance](#cc.arduino.cli.debug.Instance) - - - - - [Debug](#cc.arduino.cli.debug.Debug) - - -- [Scalar Value Types](#scalar-value-types) - - - - -

Top

- -## debug/debug.proto - - - - - -### DebugConfigReq - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| instance | [Instance](#cc.arduino.cli.debug.Instance) | | | -| fqbn | [string](#string) | | | -| sketch_path | [string](#string) | | | -| port | [string](#string) | | | -| verbose | [bool](#bool) | | | -| import_file | [string](#string) | | | - - - - - - - - -### DebugReq -The top-level message sent by the client for the `Debug` method. -Multiple `DebugReq` messages can be sent but the first message -must contain a `DebugReq` message to initialize the debug session. -All subsequent messages must contain bytes to be sent to the debug session -and must not contain a `DebugReq` message. - -Content must be either a debug session config or data to be sent. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| debugReq | [DebugConfigReq](#cc.arduino.cli.debug.DebugConfigReq) | | Provides information to the debug that specifies which is the target. The first `StreamingOpenReq` message must contain a `DebugReq` message. | -| data | [bytes](#bytes) | | The data to be sent to the target being monitored. | -| send_interrupt | [bool](#bool) | | Set this to true to send and Interrupt signal to the debugger process | - - - - - - - - -### DebugResp - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| data | [bytes](#bytes) | | | -| error | [string](#string) | | | - - - - - - - - -### Instance -TODO remove this in next proto refactoring because is a duplicate from commands/common.proto - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| id | [int32](#int32) | | | - - - - - - - - - - - - - - -### Debug -Service that abstract a debug Session usage - -| Method Name | Request Type | Response Type | Description | -| ----------- | ------------ | ------------- | ------------| -| Debug | [DebugReq](#cc.arduino.cli.debug.DebugReq) stream | [DebugResp](#cc.arduino.cli.debug.DebugResp) stream | | - - - - - -## Scalar Value Types - -| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | -| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | -| double | | double | double | float | float64 | double | float | Float | -| float | | float | float | float | float32 | float | float | Float | -| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | -| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum | -| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | -| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | -| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | -| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | -| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | -| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | -| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | -| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | -| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | -| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | -| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | - diff --git a/docs/rpc/monitor.md b/docs/rpc/monitor.md deleted file mode 100644 index 7c040b808d4..00000000000 --- a/docs/rpc/monitor.md +++ /dev/null @@ -1,130 +0,0 @@ -# Protocol Documentation - - -## Table of Contents - -- [monitor/monitor.proto](#monitor/monitor.proto) - - [MonitorConfig](#cc.arduino.cli.monitor.MonitorConfig) - - [StreamingOpenReq](#cc.arduino.cli.monitor.StreamingOpenReq) - - [StreamingOpenResp](#cc.arduino.cli.monitor.StreamingOpenResp) - - - [MonitorConfig.TargetType](#cc.arduino.cli.monitor.MonitorConfig.TargetType) - - - - [Monitor](#cc.arduino.cli.monitor.Monitor) - - -- [Scalar Value Types](#scalar-value-types) - - - - -

Top

- -## monitor/monitor.proto - - - - - -### MonitorConfig -Tells the monitor which target to open and provides additional parameters -that might be needed to configure the target or the monitor itself. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| target | [string](#string) | | | -| type | [MonitorConfig.TargetType](#cc.arduino.cli.monitor.MonitorConfig.TargetType) | | | -| additionalConfig | [google.protobuf.Struct](#google.protobuf.Struct) | | | - - - - - - - - -### StreamingOpenReq -The top-level message sent by the client for the `StreamingOpen` method. -Multiple `StreamingOpenReq` messages can be sent but the first message -must contain a `monitor_config` message to initialize the monitor target. -All subsequent messages must contain bytes to be sent to the target -and must not contain a `monitor_config` message. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| monitorConfig | [MonitorConfig](#cc.arduino.cli.monitor.MonitorConfig) | | Provides information to the monitor that specifies which is the target. The first `StreamingOpenReq` message must contain a `monitor_config` message. | -| data | [bytes](#bytes) | | The data to be sent to the target being monitored. | - - - - - - - - -### StreamingOpenResp - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| data | [bytes](#bytes) | | | - - - - - - - - - - -### MonitorConfig.TargetType - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| SERIAL | 0 | | - - - - - - - - - -### Monitor -Service that abstract a Monitor usage - -| Method Name | Request Type | Response Type | Description | -| ----------- | ------------ | ------------- | ------------| -| StreamingOpen | [StreamingOpenReq](#cc.arduino.cli.monitor.StreamingOpenReq) stream | [StreamingOpenResp](#cc.arduino.cli.monitor.StreamingOpenResp) stream | | - - - - - -## Scalar Value Types - -| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | -| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | -| double | | double | double | float | float64 | double | float | Float | -| float | | float | float | float | float32 | float | float | Float | -| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | -| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum | -| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | -| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | -| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | -| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | -| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | -| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | -| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | -| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | -| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | -| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | -| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | - diff --git a/docs/rpc/settings.md b/docs/rpc/settings.md deleted file mode 100644 index b226682cf7b..00000000000 --- a/docs/rpc/settings.md +++ /dev/null @@ -1,147 +0,0 @@ -# Protocol Documentation - - -## Table of Contents - -- [settings/settings.proto](#settings/settings.proto) - - [GetAllRequest](#cc.arduino.cli.settings.GetAllRequest) - - [GetValueRequest](#cc.arduino.cli.settings.GetValueRequest) - - [MergeResponse](#cc.arduino.cli.settings.MergeResponse) - - [RawData](#cc.arduino.cli.settings.RawData) - - [SetValueResponse](#cc.arduino.cli.settings.SetValueResponse) - - [Value](#cc.arduino.cli.settings.Value) - - - - - [Settings](#cc.arduino.cli.settings.Settings) - - -- [Scalar Value Types](#scalar-value-types) - - - - -

Top

- -## settings/settings.proto - - - - - -### GetAllRequest - - - - - - - - - -### GetValueRequest - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| key | [string](#string) | | | - - - - - - - - -### MergeResponse - - - - - - - - - -### RawData - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| jsonData | [string](#string) | | | - - - - - - - - -### SetValueResponse - - - - - - - - - -### Value - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| key | [string](#string) | | | -| jsonData | [string](#string) | | | - - - - - - - - - - - - - - -### Settings - - -| Method Name | Request Type | Response Type | Description | -| ----------- | ------------ | ------------- | ------------| -| GetAll | [GetAllRequest](#cc.arduino.cli.settings.GetAllRequest) | [RawData](#cc.arduino.cli.settings.RawData) | | -| Merge | [RawData](#cc.arduino.cli.settings.RawData) | [MergeResponse](#cc.arduino.cli.settings.MergeResponse) | | -| GetValue | [GetValueRequest](#cc.arduino.cli.settings.GetValueRequest) | [Value](#cc.arduino.cli.settings.Value) | | -| SetValue | [Value](#cc.arduino.cli.settings.Value) | [SetValueResponse](#cc.arduino.cli.settings.SetValueResponse) | | - - - - - -## Scalar Value Types - -| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | -| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | -| double | | double | double | float | float64 | double | float | Float | -| float | | float | float | float | float32 | float | float | Float | -| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | -| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum | -| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | -| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | -| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | -| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | -| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | -| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | -| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | -| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | -| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | -| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | -| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | - From a0827ba02a34ac25cef2a708c675001139d4df04 Mon Sep 17 00:00:00 2001 From: Massimiliano Pippi Date: Wed, 4 Mar 2020 18:51:14 +0100 Subject: [PATCH 12/15] improve Taskfile to support local development --- .github/workflows/docs.yaml | 9 +------- .gitignore | 4 +++- Taskfile.yml | 43 +++++++++++++++++++++++++++++++++++++ docsgen/Taskfile.yml | 12 ----------- 4 files changed, 47 insertions(+), 21 deletions(-) delete mode 100644 docsgen/Taskfile.yml diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index ce0be20838e..6a100179ce5 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -53,15 +53,8 @@ jobs: python3 -m pip install --upgrade pip python3 -m pip install -r ./requirements_docs.txt - - name: Generate command reference - working-directory: docsgen - run: task gen:commands - - - name: Generate protocol buffers reference - run: task protoc:docs - - name: Build docs website - run: mkdocs build -s + run: task docs:build - name: Deploy # publish docs only when PR is merged diff --git a/.gitignore b/.gitignore index eea1db7b0be..76546d22e23 100644 --- a/.gitignore +++ b/.gitignore @@ -23,4 +23,6 @@ venv # Mkdocs /public/ -/docsgen/arduino-cli \ No newline at end of file +/docsgen/arduino-cli +/docs/rpc/*.md +/docs/commands/*.md \ No newline at end of file diff --git a/Taskfile.yml b/Taskfile.yml index 94577d3e545..591df47852d 100755 --- a/Taskfile.yml +++ b/Taskfile.yml @@ -1,6 +1,49 @@ version: '2' +includes: + docsgen: ./docsgen + tasks: + docs:gen:commands: + desc: Generate command reference files + dir: ./docsgen + cmds: + # docs will generate examples using os.Args[0] so we need to call + # the generator `arduino-cli` + - go build -o arduino-cli + # we invoke `arduino-cli` like this instead of `./arduino-cli` to remove + # the `./` chars from the examples + - PATH=. arduino-cli ../docs/commands + + docs:gen:protobuf: + desc: Generate markdown contents for protobuffers + cmds: + - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,commands.md --proto_path=rpc ./rpc/commands/*.proto' + - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,monitor.md --proto_path=rpc ./rpc/monitor/*.proto' + - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,settings.md --proto_path=rpc ./rpc/settings/*.proto' + - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,debug.md --proto_path=rpc ./rpc/debug/*.proto' + + docs:gen: + desc: Generate documentation files + cmds: + - task: docs:gen:commands + - task: docs:gen:protobuf + + docs:build: + desc: Build documentation website contents + deps: + - docs:gen:commands + - docs:gen:protobuf + cmds: + - mkdocs build -s + + docs:serve: + desc: Run documentation website locally + deps: + - docs:build + cmds: + - mkdocs serve + protoc: desc: Compile protobuf definitions cmds: diff --git a/docsgen/Taskfile.yml b/docsgen/Taskfile.yml deleted file mode 100644 index 9a2fd74ccd7..00000000000 --- a/docsgen/Taskfile.yml +++ /dev/null @@ -1,12 +0,0 @@ -version: '2' - -tasks: - gen:commands: - desc: Generate commands reference - cmds: - # docs will generate examples using os.Args[0] so we need to call - # the generator `arduino-cli` - - go build -o arduino-cli - # we invoke `arduino-cli` like this instead of `./arduino-cli` to remove - # the `./` chars from the examples - - PATH=. arduino-cli ../docs/commands From a0959ee3d547b661723f9c7d73be7cce97c275ac Mon Sep 17 00:00:00 2001 From: Massimiliano Pippi Date: Wed, 4 Mar 2020 19:02:59 +0100 Subject: [PATCH 13/15] add docs for working on docs, much meta --- CONTRIBUTING.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9f93e13eb25..57a25a58080 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,6 +22,11 @@ If you want to run integration tests you will also need: * A serial port with an Arduino device attached * A working [Python][3] environment, version 3.5 or later +If you're working on the gRPC interface you will also have to: + +* download the [protoc][6] compiler +* run `go get -U github.com/golang/protobuf/protoc-gen-go` + ## Building the source code From the project folder root, just run: @@ -133,6 +138,36 @@ If the last step was successful, you should be able to run the tests with: task test-integration ``` +## Working on docs + +Documentation consists of several Markdown files stored under the `docs` folder +at the root of the repo. Some of those files are automatically generated in the +CI pipeline that builds the documentation website so you won't find them in the +git repository and you need to generate them locally. + +If you're working on docs and your changes are not trivial, you might want to +preview the documentation website locally, before opening a Pull Request. To run +the docs toolchain locally you need to have: + +* [Go][1] version 1.12 or later +* [Taskfile][2] to help you run the most common tasks from the command line +* A working [Python][3] environment, version 3.5 or later + +Before running the toolchain, perform the following operations: + +* go get -u github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc + +When working on docs, you can launch a command that will take care of +generating the docs, build the static website and start a local server you can +access with your browser to see a preview of your changes - to launch this +command do: + +```shell +task docs:serve +``` + +If you dont' see any error, hit http://127.0.0.1:8000 with your browser. + ## Pull Requests In order to ease code reviews and have your contributions merged faster, here is @@ -170,3 +205,4 @@ title with the string **[skip changelog]** [3]: https://www.python.org/downloads/ [4]: https://docs.python.org/3/tutorial/venv.html [5]: https://github.com/ofek/hatch +[6]: https://github.com/protocolbuffers/protobuf/releases \ No newline at end of file From fb85b331ff14590c399d7dc09551039770f0d8ff Mon Sep 17 00:00:00 2001 From: Massimiliano Pippi Date: Wed, 4 Mar 2020 19:05:54 +0100 Subject: [PATCH 14/15] leftover --- Taskfile.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/Taskfile.yml b/Taskfile.yml index 591df47852d..d98fe1bae76 100755 --- a/Taskfile.yml +++ b/Taskfile.yml @@ -1,8 +1,5 @@ version: '2' -includes: - docsgen: ./docsgen - tasks: docs:gen:commands: desc: Generate command reference files From 2672c947906537563a027afbab7a6d8aa5b5eec5 Mon Sep 17 00:00:00 2001 From: Massimiliano Pippi Date: Wed, 4 Mar 2020 19:11:19 +0100 Subject: [PATCH 15/15] restore conditional publish --- .github/workflows/docs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 6a100179ce5..6e621c55174 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -58,7 +58,7 @@ jobs: - name: Deploy # publish docs only when PR is merged - # if: github.event.pull_request.merged == 'true' + if: github.event.pull_request.merged == 'true' uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }}