Skip to content

Commit 456bab0

Browse files
authored
Create README.md
1 parent 5871bd5 commit 456bab0

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# atcoder-cli
2+
[AtCoder](https://beta.atcoder.jp/) command line tools
3+
- get contest information
4+
- create a project directory for contests
5+
- auto provisioning with custom templates
6+
- linkage with [online-judge-tools](https://github.com/kmyk/online-judge-tools)
7+
- submit your code without specified URL
8+
- auto downloading of sample inputs/outputs
9+
10+
## Requirements
11+
node.js
12+
[online-judge-tools](https://github.com/kmyk/online-judge-tools) (optional, but recommended)
13+
14+
## Install (NOT PUBLISHED YET)
15+
```sh
16+
$ npm install -g atcoder-cli
17+
```
18+
19+
## Usage
20+
```sh
21+
$ acc login # login your atcoder account
22+
$ acc session # check login status
23+
$ # your login session will be saved to a local file, but your password won't be saved
24+
$ # to delete the session file, use `acc logout`
25+
$ acc new abc001 # "abc001/" directory will be created
26+
$ cd abc001/
27+
$ acc contest # show the contest information
28+
$ acc tasks # show task list
29+
$ acc add
30+
$ cd a/
31+
$ vim main.cpp # write your solution
32+
$ acc submit main.cpp # to use submit function, you have to install online-judge-tools
33+
```
34+
35+
To get detailed information, use
36+
```sh
37+
$ acc [COMMAND] -h
38+
```
39+
40+
## Config
41+
```sh
42+
$ acc config -h
43+
$ acc config # show all global options
44+
$ acc config <key> <value> # set option
45+
$ cd `acc config-dir`
46+
$ cat config.json # global config file
47+
```

0 commit comments

Comments
 (0)