You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on May 20, 2020. It is now read-only.
> Above: Use `npx asari` in your shell to manage your work in GitHub.
10
10
11
11
"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.
12
12
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.
_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)._
16
26
17
27
## Installation
18
28
@@ -39,89 +49,135 @@ The `npx` command lets you use this tool without installing it. However, each ti
39
49
## Commands
40
50
41
51
```bash
42
-
asari
52
+
npx asari
43
53
44
54
# Display help.
45
55
```
46
56
47
57
```bash
48
-
asari <command>
58
+
npx asari <command>
49
59
50
60
# Display help for the command.
51
61
```
52
62
53
63
```bash
54
-
asari --version
64
+
npx asari --version
55
65
56
66
# Show the version number.
57
67
```
58
68
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
+
59
115
### Working with GitHub Projects
60
116
61
117
```bash
62
-
asari projects add [--column-url] [--url]
118
+
npx asari projects add [--column-url] [--url]
63
119
64
120
# Add a pull request to a GitHub project column.
65
121
```
66
122
67
123
```bash
68
-
asari projects close <github-url>
124
+
npx asari projects close <github-url>
69
125
70
126
# Set the state of an existing project board to `closed`.
71
127
```
72
128
73
129
```bash
74
-
asari projects create <github-url> [--body]
130
+
npx asari projects create <github-url> [--body]
75
131
76
132
# Create a new project.
77
133
```
78
134
79
135
### Working with GitHub Pull Requests
80
136
81
137
```bash
82
-
asari pulls close <github-url>
138
+
npx asari pulls close <github-url>
83
139
84
140
# Set the state of an existing pull request to `closed`.
85
141
```
86
142
87
143
```bash
88
-
asari pulls create-comment <github-url> [--body]
144
+
npx asari pulls create-comment <github-url> [--body]
89
145
90
146
# Create a comment on an existing pull request.
91
147
```
92
148
93
149
```bash
94
-
asari pulls create-review-request <github-url> [reviewers|team-reviewers]
150
+
npx asari pulls create-review-request <github-url> [reviewers|team-reviewers]
95
151
96
152
# Request a review for a pull request.
97
153
```
98
154
99
155
```bash
100
-
asari pulls create <github-url> [--base] [--body] [--title]
156
+
npx asari pulls create <github-url> [--base] [--body] [--title]
101
157
102
158
# Create a new pull request.
103
159
```
104
160
105
161
```bash
106
-
asari pulls delete-comment <github-url>
162
+
npx asari pulls delete-comment <github-url>
107
163
108
164
# Delete a comment on an existing pull request.
109
165
```
110
166
111
167
```bash
112
-
asari pulls delete-review-request <github-url> [reviewers|team-reviewers]
168
+
npx asari pulls delete-review-request <github-url> [reviewers|team-reviewers]
113
169
114
170
# Delete a review for a pull request.
115
171
```
116
172
117
173
```bash
118
-
asari pulls merge <github-url> [--method]
174
+
npx asari pulls merge <github-url> [--method]
119
175
120
176
# Merge an existing pull request.
121
177
```
122
178
123
179
```bash
124
-
asari pulls open <github-url>
180
+
npx asari pulls open <github-url>
125
181
126
182
# Set the state of an existing pull request to `open`.
0 commit comments