Skip to content

Commit 7d34efb

Browse files
author
jguerreiro
committed
chore(README): clarify local repository scanning
1 parent a664536 commit 7d34efb

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,17 +63,29 @@ Allows the processing of a single repository given a git clone URL
6363
1. ssh cloning
6464

6565
```sh
66-
src-fingerprint -p repository -o '[email protected]:GitGuardian/gg-shield.git'
66+
src-fingerprint -p repository -u '[email protected]:GitGuardian/gg-shield.git'
6767
```
6868

6969
2. http cloning with basic authentication
7070

7171
```sh
72-
src-fingerprint -p repository -o 'https://user:[email protected]/GitGuardian/gg-shield.git'
72+
src-fingerprint -p repository -u 'https://user:[email protected]/GitGuardian/gg-shield.git'
7373
```
7474

7575
2. http cloning without basic authentication
7676

7777
```sh
78-
src-fingerprint -p repository -o 'https://github.com/GitGuardian/gg-shield.git'
78+
src-fingerprint -p repository -u 'https://github.com/GitGuardian/gg-shield.git'
79+
```
80+
81+
3. repository in a local directory
82+
83+
```sh
84+
src-fingerprint -p repository -u /projects/gitlab/src-fingerprint
85+
```
86+
87+
4. repository in current directory
88+
89+
```sh
90+
src-fingerprint -p repository -u .
7991
```

provider/generic_repository.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ func NewGenericProvider(options Options) Provider {
4343

4444
func (p *GenericProvider) Gather(user string) ([]GitRepository, error) {
4545
if user == "" {
46-
return nil, errors.New("This provider requires a object. Example: src-fingerprint -p repository -o '[email protected]:GitGuardian/gg-shield.git'") // nolint
46+
return nil, errors.New("This provider requires a object. Example: src-fingerprint -p repository -u '[email protected]:GitGuardian/gg-shield.git'") // nolint
4747
}
4848

4949
return []GitRepository{&Repository{

0 commit comments

Comments
 (0)