/ 
Beagle-0.01
River stage zero No dependents
/ Beagle::Manual::Tutorial

NAME

Beagle::Manual::Tutorial - Tutorial

DESCRIPTION

INSTALL

Beagle requires git, so please make sure you have it installed.

Beagle is a plain CPAN module, so you can install it via CPAN or CPANPLUS or App::cpanminus:

$ cpan Beagle
$ cpanp -i Beagle
$ cpanm Beagle

INIT CONFIG

$ beagle config --init

INIT AND FOLLOW

create a beagle:

$ beagle init /tmp/foo.git --bare

clone it into Beagle's kennel

$ beagle follow /tmp/foo.git

you can follow it from another box too, as it's a plain git repository.

USE

$ beagle help
$ beagle ls # no output as we haven't created anything
$ beagle info -n foo --edit # edit foo's info
$ beagle article -n foo --title homer --body doh
$ beagle bark -n foo 'bart is a good boy'
$ beagle ls
$ beagle articles
$ beagle barks
$ beagle cat id1
$ beagle update id1
$ beagle rm id1

PULL AND PUSH AND SPREAD

$ beagle pull -n foo # from original /tmp/foo.git
$ beagle push -n foo # to original /tmp/foo.git

$ beagle spread id1 --command command --template-file short
$ beagle help spread

START WEB SERVER

$ beagle web -n foo
$ beagle web -n foo --port 8080

ADVANCED

SET DEFAULT BEAGLE

it's annoying if we have to specify the beagle name by -n foo in commands, here are some ways to avoid this:

ENV BEAGLE_NAME
$ export BEAGLE_NAME=foo
share/etc/bashrc

it's in share root of Beagle, which supplies 3 extra "commands": which, use and switch.

which shows current beagle name, switch switches default beagle, use switches default beagle only in current session.

$ beagle which
$ beagle switch foo
$ beagle use foo

SEE ALSO

Beagle, Beagle::Manual::ENV, Beagle::Manual::Cookbook

AUTHOR

sunnavy <sunnavy@gmail.com>

LICENCE AND COPYRIGHT

Copyright 2011 sunnavy@gmail.com

This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.