Installation

After downloading shpub-x.y.z.phar, you can either use it directly:

$ php /path/to/shpub-x.y.z.phar --version

or make it more easily accessible:

$ mv /path/to/shpub-x.y.z.phar /usr/local/bin/shpub
$ chmod +x /usr/local/bin/shpub
$ shpub --version

You might need sudo to be able to copy it into the /usr/local/bin/ directory.

If you're running from the git checkout, start it as follows:

$ ./bin/shpub.php --version

Dependencies

When using the git version, you need to have the following dependencies installed on your system:

• PHP 5.4+
• PEAR's Console_CommandLine
• PEAR's HTTP_Request2
• PEAR's MIME_Type
• PEAR's NET_URL2

$ shpub connect http://mywebsite

$ shpub connect http://sharedwebsite http://shareswebsite/user

List configured servers/connections

$ shpub server
rr
test
anoweco.bogo
local2

Also try server -v which lists server and user URLs.

Create a like

$ shpub like http://example.org/
Like created at server
http://anoweco.bogo/comment/23.htm

Create a reply

$ shpub reply http://example.org/ "Hey, cool!"
Reply created at server
http://anoweco.bogo/comment/42.htm

Create a note

A normal note:

$ shpub note "oh this is cool!"
Note created at server
http://known.bogo/2016/oh-this-is-cool.htm

Note with an image:

$ shpub note -f image.jpg "this is so cute"
Note created at server
http://known.bogo/2016/this-is-so-cute

You can use -f several times to upload multiple files.

URL image upload:

$ shpub note -f http://example.org/1.jpg "img url!"
Note created at server
http://known.bogo/2016/img-url

Load note content from a file:

$ shpub note - < /path/to/file.txt
Note created at server
http://known.bogo/2017/some-note

Custom post types

You may create custom post types with the x command. This is useful if your micropub endpoint supports additional types, like known's "annotation" type (comments and likes for posts).

Create a comment to a known post:

$ shpub x annotation\
    -x url=http://known.bogo/2016/example-domain-1\
    -x type=reply\
    -x username=barryf\
    -x userurl=http://example.org/~barryf\
    -x userphoto=http://example.org/~barryf/avatar.jpg\
    -x content="There is a typo in paragraph 1. 'Fou' should be 'Foo'"

$ shpub -s known -d note "a simple note"
curl -X POST -H 'User-Agent: shpub' -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Bearer abc' -d 'h=entry' -d 'content=a simple note' 'http://known.bogo/micropub/endpoint'
Post created at server
http://known.bogo/2016/a-simple-note

See curl commands only

You may use the --dry-run option to make shpub not send any modifying HTTP requests (e.g. POST and PUT).

Together with --debug you can use this to get curl commands without sending anything to the server:

$ shpub --debug --dry-run like example.org
curl -X POST -H 'User-Agent: shpub' -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Bearer cafe' -d 'h=entry' -d 'like-of=http://example.org' 'http://anoweco.bogo/micropub.php'
Like created at server
http://example.org/fake-response

Server information

To see which server, user and endpoint URLs shpub uses, pass the server name to the server command:

$ shpub server commentpara.de
commentpara.de
 URL:   http://commentpara.de
 User:  https://commentpara.de/user/3.htm
 Endpoints:
  micropub:      https://commentpara.de/micropub.php
  media:
  token:         https://commentpara.de/token.php
  authorization: https://commentpara.de/auth.php

Releasing a new version

1. Add notes to ChangeLog
2. Update version number in build.xml and src/shpub/Cli.php
3. Run phing
4. Commit and tag the version
5. In the cweiske.de directory, run ./scripts/update-shpub.sh

Source code

shpub's source code is available from http://git.cweiske.de/shpub.git or the mirror on github.

License

shpub is licensed under the AGPL v3 or later.

Author

shpub was written by Christian Weiske.