Skip to content

Commit 10fb3c6

Browse files
committed
chore(readme): update readme for the project
1 parent 8624f7e commit 10fb3c6

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -80,19 +80,19 @@ $ go get -u github.com/gitguardian/src-fingerprint/cmd/src-fingerprint
8080

8181
### GitHub
8282

83-
1. Click on your profile picture at the top right of the screen. A dropdown menu will appear and you will be able to access your personal settings by clicking on _Settings_
84-
2. On your profile, go to Developer Settings
85-
3. Select Personal Access Tokens
86-
4. Click on `Generate a new token`
87-
5. Click the `repo` box. This is the only scope we need
88-
6. Click on `Generate token`. The token will only be available at this time so make sure you keep it in a safe place
83+
1. Click on your profile picture at the top right of the screen. A dropdown menu will appear and you will be able to access your personal settings by clicking on _Settings_.
84+
2. On your profile, go to Developer Settings.
85+
3. Select Personal Access Tokens.
86+
4. Click on `Generate a new token`.
87+
5. Click the `repo` box. This is the only scope we need.
88+
6. Click on `Generate token`. The token will only be available at this time so make sure you keep it in a safe place.
8989

9090
### GitLab
9191

92-
1. Click on your profile picture at the top right of the screen. A dropdown menu will appear and you will be able to access your personal settings by clicking on _Preferences_
93-
2. In the left sidebar, click on `Access Tokens`
94-
3. Click the `read repository` box. This is the only scope we need. You can set an end-date for the token validity if you want more security
95-
4. Click on `Create personal token`. The token will only be available at this time so make sure you keep it in a safe place
92+
1. Click on your profile picture at the top right of the screen. A dropdown menu will appear and you will be able to access your personal settings by clicking on _Preferences_.
93+
2. In the left sidebar, click on `Access Tokens`.
94+
3. Click the `read_api` box. This is the only scope we need. You can set an end-date for the token validity if you want more security.
95+
4. Click on `Create personal token`. The token will only be available at this time so make sure you keep it in a safe place.
9696

9797
## Collect my code fingerprints
9898

@@ -138,7 +138,8 @@ env VCS_TOKEN="<token>" src-fingerprint -v collect --provider github --include-p
138138

139139
### GitLab
140140

141-
1. Export all fingerprints from private repositories of a GitLab group to the default path `./fingerprints.jsonl.gz` with logs:
141+
1. Export all fingerprints from private repositories of a GitLab group to the default path `./fingerprints.jsonl.gz` with logs:
142+
**Note :** If you are targeting a self-hosted GitLab instance, use the `--provider-url` to specify its url, don't forget to include the scheme.
142143

143144
```sh
144145
env VCS_TOKEN="<token>" src-fingerprint -v collect --provider gitlab --object "GitGuardian-dev-group"
@@ -152,7 +153,8 @@ env VCS_TOKEN="<token>" src-fingerprint -v collect --provider gitlab --include-f
152153

153154
### Bitbucket server (formely Atlassian Stash)
154155

155-
1. Export all fingerprints from a Bitbucket project with private repository to the default path `./fingerprints.jsonl.gz` with logs:
156+
1. Export all fingerprints from a Bitbucket project with private repository to the default path `./fingerprints.jsonl.gz` with logs:
157+
**Note :** If you are targeting a self-hosted BitBucket instance, use the `--provider-url` to specify its url, don't forget to include the scheme.
156158

157159
```sh
158160
env VCS_TOKEN="<token>" src-fingerprint -v collect --provider bitbucket --object "GitGuardian Project"

0 commit comments

Comments
 (0)