File tree 1 file changed +40
-3
lines changed
1 file changed +40
-3
lines changed Original file line number Diff line number Diff line change @@ -12,14 +12,51 @@ G-stack is a CLI util to simplify creating stacked branches and pull requests on
12
12
## Configuration
13
13
14
14
To be able to create and modify github prs a personal access token is needed.
15
- To specify it create a config file with the following content in ` $HOME/.gstack/config.toml `
15
+ Check [ the official github docs] ( https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens )
16
+ and make sure the token has read/write access to pull requests.
17
+ Then create a config file with the following content in ` $HOME/.gstack/config.toml `
16
18
17
19
``` toml
18
20
personal_access_token = " <GITHUB_PERSONAL_ACCESS_TOKEN>"
19
-
20
21
```
21
22
22
23
## Usage
23
24
24
25
_ Show available commands_
25
- ` gs help `
26
+
27
+ ``` bash
28
+ gs help
29
+ ```
30
+
31
+ _ Create a new stack_
32
+
33
+ Creates a new stack with the current branch as a base and checks out the new branch
34
+
35
+ ``` bash
36
+ gs new
37
+ ```
38
+
39
+ _ Add a new stack branch_
40
+
41
+ Stacks a new branch on top of the current stac
42
+
43
+ ``` bash
44
+ gs add
45
+ ```
46
+
47
+ _ Moving through stack branches_
48
+
49
+ Move up and down trough stack branches with:
50
+
51
+ ``` bash
52
+ gs up
53
+ gs down
54
+ ```
55
+
56
+ or interactively select a stack branch with
57
+
58
+ ``` bash
59
+ gs change
60
+ # or
61
+ gs c
62
+ ```
You can’t perform that action at this time.
0 commit comments