summaryrefslogtreecommitdiffstats
path: root/src/user.rs
diff options
context:
space:
mode:
Diffstat (limited to 'src/user.rs')
-rw-r--r--src/user.rs28
1 files changed, 28 insertions, 0 deletions
diff --git a/src/user.rs b/src/user.rs
index 2b12867..d38d8b5 100644
--- a/src/user.rs
+++ b/src/user.rs
@@ -6,6 +6,7 @@ use crate::{repo::RepoInfo, SpecialRender};
#[derive(Args, Clone, Debug)]
pub struct UserCommand {
+ /// The local git remote that points to the repo to operate on.
#[clap(long, short = 'R')]
remote: Option<String>,
#[clap(subcommand)]
@@ -14,46 +15,66 @@ pub struct UserCommand {
#[derive(Subcommand, Clone, Debug)]
pub enum UserSubcommand {
+ /// Search for a user by username
Search {
/// The name to search for
query: String,
#[clap(long, short)]
page: Option<usize>,
},
+ /// View a user's profile page
View {
/// The name of the user to view
+ ///
+ /// Omit to view your own page
user: Option<String>,
},
+ /// Open a user's profile page in your browser
Browse {
/// The name of the user to open in your browser
+ ///
+ /// Omit to view your own page
user: Option<String>,
},
+ /// Follow a user
Follow {
/// The name of the user to follow
user: String,
},
+ /// Unfollow a user
Unfollow {
/// The name of the user to follow
user: String,
},
+ /// List everyone a user's follows
Following {
/// The name of the user whose follows to list
+ ///
+ /// Omit to view your own follows
user: Option<String>,
},
+ /// List a user's followers
Followers {
/// The name of the user whose followers to list
+ ///
+ /// Omit to view your own followers
user: Option<String>,
},
+ /// Block a user
Block {
/// The name of the user to block
user: String,
},
+ /// Unblock a user
Unblock {
/// The name of the user to unblock
user: String,
},
+ /// List a user's repositories
Repos {
/// The name of the user whose repos to list
+ ///
+ /// Omit to view your own repos.
user: Option<String>,
/// List starred repos instead of owned repos
#[clap(long)]
@@ -62,14 +83,21 @@ pub enum UserSubcommand {
#[clap(long)]
sort: Option<RepoSortOrder>,
},
+ /// List the organizations a user is a member of
Orgs {
/// The name of the user to view org membership of
+ ///
+ /// Omit to view your own orgs.
user: Option<String>,
},
+ /// List a user's recent activity
Activity {
/// The name of the user to view the activity of
+ ///
+ /// Omit to view your own activity.
user: Option<String>,
},
+ /// Edit your user settings
#[clap(subcommand)]
Edit(EditCommand),
}