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 ika` in your shell to manage your work in GitHub.
9
+
> Above: Use `npx asari` in your shell to manage your work in GitHub.
10
10
11
-
"Ika" (いか) is [Japanese for squid/cuttlefish](https://translate.google.com/#view=home&op=translate&sl=en&tl=ja&text=Squid). Like a squid, the `ika` command line tool is an elongated, fast-swimming cephalopod mollusk with ten arms (technically, eight arms and two long tentacles), typically able to change color.
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
-
`ika` lets you work with GitHub from your shell, 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
19
29
### Global installation (recommmended)
20
30
21
31
```bash
22
-
npm install --global ika
32
+
npm install --global asari
23
33
```
24
34
25
35
When you run the tool, it will automatically notify you if there is a newer version of it available for you to update to.
@@ -29,99 +39,145 @@ When you run the tool, it will automatically notify you if there is a newer vers
29
39
### No installation
30
40
31
41
```bash
32
-
npx ika
42
+
npx asari
33
43
```
34
44
35
45
The `npx` command lets you use this tool without installing it. However, each time you use `npx` it downloads the whole package from the npm registry, which takes a while. That's why global installation is reccommended.
36
46
37
-
> Note: If this tool is globally installed, `npx ika` will use that globally installed version rather than downloading.
47
+
> Note: If this tool is globally installed, `npx asari` will use that globally installed version rather than downloading.
38
48
39
49
## Commands
40
50
41
51
```bash
42
-
ika
52
+
npx asari
43
53
44
54
# Display help.
45
55
```
46
56
47
57
```bash
48
-
ika<command>
58
+
npx asari<command>
49
59
50
60
# Display help for the command.
51
61
```
52
62
53
63
```bash
54
-
ika --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
-
ika 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
-
ika 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
-
ika 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
-
ika 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
-
ika pulls create-comment <github-url> [--body]
144
+
npx asari pulls create-comment <github-url> [--body]
Copy file name to clipboardexpand all lines: bin/asari.js
+3-3
Original file line number
Diff line number
Diff line change
@@ -16,14 +16,14 @@ const baseOptions = flow([
16
16
commonYargs.withJson(),
17
17
])
18
18
baseOptions(yargs)
19
-
.scriptName('ika')
19
+
.scriptName('asari')
20
20
.usage('$0 <command> <subcommand> [...options]')
21
21
/**
22
-
* The --version argument only makes sense as an option for the main `ika` command.
22
+
* The --version argument only makes sense as an option for the main `asari` command.
23
23
*/
24
24
.command('[--version]','Show the version number.')
25
25
.hide('version')
26
-
.completion('completion','Output a generated script. To enable bash/zsh completions: \n 1. Install ika globally. \n 2. Add the script to your .bashrc or .bash_profile (or .zshrc for zsh).')
26
+
.completion('completion','Output a generated script. To enable bash/zsh completions: \n 1. Install asari globally. \n 2. Add the script to your .bashrc or .bash_profile (or .zshrc for zsh).')
27
27
/**
28
28
* Load our yargs command modules from a directory.
0 commit comments