https://github.com/mjm/pressy
A command-line tool for editing your WordPress site using local files
https://github.com/mjm/pressy
cli ruby rubygems wordpress
Last synced: about 1 month ago
JSON representation
A command-line tool for editing your WordPress site using local files
- Host: GitHub
- URL: https://github.com/mjm/pressy
- Owner: mjm
- License: mit
- Created: 2018-05-07T02:28:11.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-06-10T21:31:23.000Z (about 8 years ago)
- Last Synced: 2025-01-23T12:11:54.115Z (over 1 year ago)
- Topics: cli, ruby, rubygems, wordpress
- Language: Ruby
- Homepage: https://mjm.github.io/pressy/
- Size: 203 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Pressy
Pressy lets you work with your WordPress site as though you were using a static site generator like [Jekyll](https://jekyllrb.com).
## Installation
Pressy is a work-in-progress and is not yet published as a RubyGem.
## Usage
### Initializing a new site directory
Before you can use Pressy, you need to set up a directory to hold the files for your site.
$ mkdir example.com
$ cd example.com
$ pressy init
# TODO output from init
This will create a `.pressy/config.yml` file in the `example.com` directory. This configuration will allow subsequent `pressy` commands to connect to your WordPress site.
### Pulling changes from WordPress
To sync the contents of your posts on WordPress to your local directory, you can run `pressy pull`.
$ pressy pull
Updated 5 posts.
```
TODO more commands
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/mjm/pressy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## Code Status
[](https://travis-ci.com/mjm/pressy)
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Pressy project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mjm/pressy/blob/master/CODE_OF_CONDUCT.md).