Skip to content

Commit

Permalink
Readme update.
Browse files Browse the repository at this point in the history
  • Loading branch information
boonebgorges committed Nov 20, 2017
1 parent 711f9b5 commit 526adcc
Showing 1 changed file with 6 additions and 89 deletions.
95 changes: 6 additions & 89 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,99 +1,16 @@
# wp-cli-buddypress

WP-CLI commands for use with BuddyPress. Currently supported commands:

### Core Commands
* `bp core activate` -- Activate a component.
* `bp core deactivate` -- Deactivate a component.

### Tool Commands
* `bp tool repair` -- Repair something on BuddyPress.
* `bp tool reinstall_emails` -- Reinstall BuddyPress default emails.

### Signup Commands
* `bp signup add` -- Create a signup.
* `bp signup delete` -- Delete a signup.
* `bp signup get` -- Get a signup.
* `bp signup activate` -- Activate a signup.
* `bp signup generate` -- Generate signups.
* `bp signup resend` -- Resend a signup.
* `bp signup list` -- Get a list of signups.

### Activity Commands
* `bp activity create` -- Create a single activity item.
* `bp activity delete` -- Delete an activity.
* `bp activity generate` -- Generate a large number of random activity items.
* `bp activity list` -- Get a list of activities.
* `bp activity get` -- Get an activity.
* `bp activity spam` -- Spam an activity.
* `bp activity ham` -- Ham an activity.
* `bp activity post_update` -- Post an activity update.
* `bp activity comment` -- Add an activity comment.
* `bp activity delete_comment` -- Delete an activity comment.

#### Activitiy Favorites Commands
* `bp activity favorite add` -- Add an activity item as a favorite for a user.
* `bp activity favorite add` -- Remove an activity item as a favorite for a user.
* `bp activity favorite list` -- Get a user's favorite activity items.

### Group Commands
* `bp group create` -- Create a group.
* `bp group delete` -- Delete a group.
* `bp group get` -- Get a group.
* `bp group update` -- Update a group.
* `bp group list` -- List groups.
* `bp group generate` -- Generate a large number of random groups.

#### Group Invites Commands
* `bp group invite add` -- Invite a user from a group.
* `bp group invite remove` -- Uninvite a user from a group.
* `bp group invite list` -- Get a list of invitations from a group.
* `bp group invite generate` -- Generate random group invitations.
* `bp group invite accept` -- Accept a group invitation.
* `bp group invite reject` -- Reject a group invitation.
* `bp group invite delete` -- Delete a group invitation.

#### Group Members Commands
* `bp group member add` -- Add a group member.
* `bp group member remove` -- Remove a group member.
* `bp group member list` -- List group members.
* `bp group member promote` -- Promote a member to a new status withing a group.
* `bp group member demote` -- Demote user to the 'member' status.
* `bp group member ban` -- Ban a member from a group.
* `bp group member unban` -- Unban a member from a group.

### Member Command
* `bp member generate` -- Create lots of site members, with the proper BP metadata.

### XProfile Commands

#### XProfile Group Commands
* `bp xprofile group create` -- Create an XProfile field group.
* `bp xprofile group delete` -- Delete an XProfile field group.
* `bp xprofile group get` -- Fetch an XProfile field group.

#### XProfile Field Commands
* `bp xprofile field create` -- Create an XProfile field.
* `bp xprofile field delete` -- Delete an XProfile field.
* `bp xprofile field get` -- Get an XProfile field.
* `bp xprofile field list` -- List XProfile fields.

#### XProfile Data Commands
* `bp xprofile data set` -- Set XProfile data for user.
* `bp xprofile data get` -- Get XProfile data for user.
* `bp xprofile data delete` -- Delete XProfile data for user.

## Why doesn't this do _x_?

Because I haven't built it yet. I'm filling in commands as I need them, which means that they are largely developer-focused. I'll fill in more commands as I need them. Pull requests will be enthusiastically received.
WP-CLI commands for use with BuddyPress.

These commands may be in flux, as we work toward a potential merge into BuddyPress. See https://buddypress.trac.wordpress.org/ticket/7604.

Please use and provide feedback!

## System Requirements

* PHP >=5.3
* wp-cli >=0.23.0

If you need support for wp-cli < 0.15.0, please use the 1.1.x branch.

## Setup

* Install [wp-cli](https://wp-cli.org)
Expand All @@ -104,7 +21,7 @@ If you need support for wp-cli < 0.15.0, please use the 1.1.x branch.

### 1.5.0

* CRUD commands introduced to the BuddyPress components
* CRUD commands introduced to the main BuddyPress components
* Behat tests added for all commands
* Codebase fixed for WPCS

Expand Down

0 comments on commit 526adcc

Please sign in to comment.