Skip to content
This repository was archived by the owner on May 20, 2020. It is now read-only.

Commit 5a141ff

Browse files
author
Adam Braimbridge
committed
Updated README. Added 'asari issue' commands.
1 parent 4a24b8f commit 5a141ff

File tree

1 file changed

+73
-17
lines changed

1 file changed

+73
-17
lines changed

README.md

+73-17
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,25 @@
44

55
<sup>1</sup> It's script-friendly too.
66

7-
![image](https://user-images.githubusercontent.com/224547/57764890-42704180-76fc-11e9-9256-2be2037e2fdf.png)
7+
![image](https://user-images.githubusercontent.com/224547/58557351-1a153680-8216-11e9-9ebc-f25471405ea3.png)
88

99
> Above: Use `npx asari` in your shell to manage your work in GitHub.
1010
1111
"Asari" (あさり) is [Japanese for "clam"](https://translate.google.com/#view=home&op=translate&sl=en&tl=ja&text=clam). Like a clam, `asari` is happiest when it's inside a shell.
1212

13-
`asari` lets you work with GitHub from your command line, and is delicious when lightly fried with garlic and spices.
13+
🐚 `asari` lets you work with GitHub from your command line, and is delicious when lightly fried with garlic and spices.
1414

15-
![image](https://user-images.githubusercontent.com/224547/57698749-3a59c880-764e-11e9-8dc1-92587f4dd884.png)
15+
![image](https://user-images.githubusercontent.com/224547/58558164-010d8500-8218-11e9-9279-9b93307989a7.png)
16+
17+
_Above: Running `npx asari` from your command line shows you the top level of options and commands._
18+
19+
![image](https://user-images.githubusercontent.com/224547/58558212-213d4400-8218-11e9-8b46-42be9ea9d0e9.png)
20+
21+
![image](https://user-images.githubusercontent.com/224547/58558194-15518200-8218-11e9-8d48-0832558413ad.png)
22+
23+
![image](https://user-images.githubusercontent.com/224547/58558179-0c60b080-8218-11e9-8e17-d5823b55c5ad.png)
24+
25+
_Above: Running `npx asari <command>` shows you options for working with GitHub [issues](#working-with-github-issues), [projects](#working-with-github-projects) and [pull requests](#working-with-github-pull-requests)._
1626

1727
## Installation
1828

@@ -39,89 +49,135 @@ The `npx` command lets you use this tool without installing it. However, each ti
3949
## Commands
4050

4151
```bash
42-
asari
52+
npx asari
4353

4454
# Display help.
4555
```
4656

4757
```bash
48-
asari <command>
58+
npx asari <command>
4959

5060
# Display help for the command.
5161
```
5262

5363
```bash
54-
asari --version
64+
npx asari --version
5565

5666
# Show the version number.
5767
```
5868

69+
```bash
70+
npx asari allowance
71+
72+
# Display current GitHub API rate-limiting allowance.
73+
```
74+
75+
```bash
76+
npx asari completion
77+
78+
# Output a generated script. To enable bash/zsh completions:
79+
# 1. Install asari globally.
80+
# 2. Add the script to your .bashrc or .bash_profile (or .zshrc for zsh).
81+
```
82+
83+
### Working with GitHub Issues
84+
85+
```bash
86+
npx asari issues create <github-url> [--title] [--body] [--assignees]
87+
88+
# Create a new issue
89+
```
90+
91+
```bash
92+
npx asari issues open <github-url>
93+
94+
# Set the state of an existing issue to `open`
95+
```
96+
97+
```bash
98+
npx asari issues close <github-url>
99+
100+
# Set the state of an existing issue to `closed`
101+
```
102+
103+
```bash
104+
npx asari issues list [--type]
105+
106+
# List all issues assigned to the authenticated user.
107+
```
108+
109+
```bash
110+
npx asari issues list-for-repo <github-url>
111+
112+
# List all issues in a repository.
113+
```
114+
59115
### Working with GitHub Projects
60116

61117
```bash
62-
asari projects add [--column-url] [--url]
118+
npx asari projects add [--column-url] [--url]
63119

64120
# Add a pull request to a GitHub project column.
65121
```
66122

67123
```bash
68-
asari projects close <github-url>
124+
npx asari projects close <github-url>
69125

70126
# Set the state of an existing project board to `closed`.
71127
```
72128

73129
```bash
74-
asari projects create <github-url> [--body]
130+
npx asari projects create <github-url> [--body]
75131

76132
# Create a new project.
77133
```
78134

79135
### Working with GitHub Pull Requests
80136

81137
```bash
82-
asari pulls close <github-url>
138+
npx asari pulls close <github-url>
83139

84140
# Set the state of an existing pull request to `closed`.
85141
```
86142

87143
```bash
88-
asari pulls create-comment <github-url> [--body]
144+
npx asari pulls create-comment <github-url> [--body]
89145

90146
# Create a comment on an existing pull request.
91147
```
92148

93149
```bash
94-
asari pulls create-review-request <github-url> [reviewers|team-reviewers]
150+
npx asari pulls create-review-request <github-url> [reviewers|team-reviewers]
95151

96152
# Request a review for a pull request.
97153
```
98154

99155
```bash
100-
asari pulls create <github-url> [--base] [--body] [--title]
156+
npx asari pulls create <github-url> [--base] [--body] [--title]
101157

102158
# Create a new pull request.
103159
```
104160

105161
```bash
106-
asari pulls delete-comment <github-url>
162+
npx asari pulls delete-comment <github-url>
107163

108164
# Delete a comment on an existing pull request.
109165
```
110166

111167
```bash
112-
asari pulls delete-review-request <github-url> [reviewers|team-reviewers]
168+
npx asari pulls delete-review-request <github-url> [reviewers|team-reviewers]
113169

114170
# Delete a review for a pull request.
115171
```
116172

117173
```bash
118-
asari pulls merge <github-url> [--method]
174+
npx asari pulls merge <github-url> [--method]
119175

120176
# Merge an existing pull request.
121177
```
122178

123179
```bash
124-
asari pulls open <github-url>
180+
npx asari pulls open <github-url>
125181

126182
# Set the state of an existing pull request to `open`.
127183
```

0 commit comments

Comments
 (0)