https://github.com/mach-kernel/lazywake

Better wakeonlan replacement that intuitively uses your ARP table to cache hostnames.
https://github.com/mach-kernel/lazywake

Last synced: 9 months ago
JSON representation

Better wakeonlan replacement that intuitively uses your ARP table to cache hostnames.

• Host: GitHub
• URL: https://github.com/mach-kernel/lazywake
• Owner: mach-kernel
• License: mit
• Created: 2016-08-24T18:07:32.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-03-14T21:33:49.000Z (about 9 years ago)
• Last Synced: 2025-02-26T08:19:14.123Z (about 1 year ago)
• Language: Ruby
• Size: 142 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: ChangeLog.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# lazywake

[![Code Climate GPA](https://codeclimate.com/github/mach-kernel/lazywake/badges/gpa.svg)](https://codeclimate.com/github/mach-kernel/lazywake)

[![CircleCI](https://circleci.com/gh/mach-kernel/lazywake/tree/master.svg?style=shield)](https://circleci.com/gh/mach-kernel/lazywake/tree/master)

[![Test Coverage](https://codeclimate.com/github/mach-kernel/lazywake/badges/coverage.svg)](https://codeclimate.com/github/mach-kernel/lazywake/coverage)

[![Issue Count](https://codeclimate.com/github/mach-kernel/lazywake/badges/issue_count.svg)](https://codeclimate.com/github/mach-kernel/lazywake)

* [Homepage](https://rubygems.org/gems/lazywake)

* [Documentation](http://rubydoc.info/gems/lazywake/frames)

**NOTE:** This is still a work in progress and a lot of features are not done yet. I fill things in as I go!

## Description

A better wake-on-lan utility that saves hostname to hardware address mappings. 

## Getting Started

##### Wake a host by name

`lazywake myhost`

##### Wake a host, then do something

```bash

lazywake myhost echo 'done'

# => done

```

##### Wake a host, wait for it to come up, then use the SSH plugin to log in

```bash

lazywake myhost ssh

# => (...myhost's MOTD)

``` 

## Plugins

A `plugin` is a subclass of `Lazywake::Command::Default` that implements additional behavior for sake of terseness and readability.

Consider connecting to an SSH host after sending a magic packet:

Doing `lazywake myhost ssh user@myhost` seems redundant: we know our current user and the destination host. We can do less typing, so why not just `lazywake myhost ssh`?

### Creating a plugin

In typical Ruby fashion, there's a DSL for this!

##### Define the foobar command

```ruby

Lazywake::Command.describe do 

  # Program to locate via `which`

  name 'foobar'

  # How long should we wait for the host to wake up? In this case, we would

  # send 10 packets, 1 per second, stopping on first reply and replacing the

  # process, or waiting 10s for all 10 pings to time out.

  await_for 10

  # Before we replace the process,

  # you can do whatever manipulations you'd like on the args

  map_proc do |args|

    args[0].upcase!

  end

end

```

## Credits

Copyright (c) David Stancu 2016 

See LICENSE.txt for details.