particle-cli Cookbook

Installs particle-cli from a pre-built binary and related libraries. Based on chef-particle-base, but more atomic. This cookbook is intended to support a workflow in a local particle cloud where one desires a build environment that runs on a VM instead of an RPi. That isn't to say an RPi can't be used for Particle development, because it can, to an extent. This cookbook does not use NPM to install particle-cli, but support can be added for that install method, as well as particle-cli-wrapper.

Not tested on RPi.

Requirements

Platforms

• Debian/Ubuntu
• Mac OS X
• Windows?

Chef

• Chef 12.0+

Cookbooks

• apt -- needed for lib32c packages
• git -- needed for particle firmware repo. and other libraries
• nvm -- for NodeJS installation - TODO: parametrize so Node can be pre-installed

Attributes

Customize the attributes to suit site specific conventions and defaults.
- node['particle_cli']['dir'] - user to use for install. defaults to /home/[user]/particle.
- node['particle_cli']['directories']['tmp'] - location of tmp folder to use for cookbook activities.

particle-cli::default

particle-cli::particle_cli

Resources

Not currently defined.

Actions

• :create: Downloads a particle-cli prebuilt-binary and installs it. Also downloads Particle's core firmware, core common, and core communication libraries. Creates a friendly-symlink for compiling Particle firmware with gcc-arm-embedded.

Usage

particle-cli::default

Just include particle-cli in your node's run_list:

{
  "name":"my_node",
  "run_list": [
    "recipe[particle-cli]"
  ]
}

Examples

Install particle-cli in non-default folder with non-default user.
ruby
particle-cli do
user 'my-user'
group 'my-group'
action :create
end


Install particle-cli in default folder for default user with non-default binary version.
ruby
particle-cli do
source_url 'https://dfu55fst9l042.cloudfront.net/master/0.0.1-dedbf1f/darwin/amd64/particle-cli-ng.gz'
action :create
end


Contributing

1. Fork the repository on Github
2. Create a named feature branch (like add_component_x)
3. Write your change
4. Write tests for your change (if applicable)
5. Run the tests, ensuring they all pass
6. Submit a Pull Request using Github

License & Authors

• Author: Free Beachler, Longevity Software LLC, (longevitysoft@gmail.com)
• Copyright: 2016, Free Beachler

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.