README.rst

   1 **************************************
   2 shpub - micropub client for your shell
   3 **************************************
   4 Command line micropub client written in PHP.
   5
   6
   7 =====
   8 Usage
   9 =====
  10
  11 Initial setup
  12 =============
  13 ::
  14
  15     $ ./bin/shpub.php connect http://mywebsite http://mywebsite/user
  16
  17 If you pass a third parameter, then it will be the name of the connection.
  18 You can select a specific server/connection with ``-s`` on all commands.
  19
  20
  21 List configured servers/connections
  22 ===================================
  23 ::
  24
  25     $ ./bin/shpub.php server
  26     rr
  27     test
  28     anoweco.bogo
  29     local2
  30
  31 Also try ``-v`` which lists server and user URLs.
  32
  33
  34 Create a like
  35 =============
  36 ::
  37
  38     $ ./bin/shpub.php like http://example.org/
  39     Like created at server
  40     http://anoweco.bogo/comment/23.htm
  41
  42 Create a reply
  43 ==============
  44 ::
  45
  46     $ ./bin/shpub.php reply http://example.org/ "Hey, cool!"
  47     Reply created at server
  48     http://anoweco.bogo/comment/42.htm
  49
  50
  51 Create a note
  52 =============
  53 A normal note::
  54
  55     $ ./bin/shpub.php note "oh this is cool!"
  56     Reply created at server
  57     http://known.bogo/2016/oh-this-is-cool.htm
  58
  59 Note with an image::
  60
  61     $ ./bin/shpub.php note -f image.jpg "this is so cute"
  62     Reply created at server
  63     http://known.bogo/2016/this-is-so-cute.htm
  64
  65 You can use ``-f`` several times to upload multiple files.
  66
  67 URL image upload::
  68
  69     $ ./bin/shpub.php note -f http://example.org/1.jpg "img url!"
  70     Reply created at server
  71     http://known.bogo/2016/img-url.htm