Skip to content
This repository was archived by the owner on Nov 16, 2023. It is now read-only.

Add instructions for user queueing and clarify README #11

Open
danisyellis wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Add instructions for user queueing and clarify README #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d6a2375
adds instructions to queue a user using the cli queue command
danisyellis Dec 13, 2019
776d883
make a few instructions in the README more clear
danisyellis Dec 13, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
The `cc` utility is in the `bin` directory of this repo. It can be run interactively or as a single command processor. The general format of using the command line is

```
node cc [options] [command]
node bin/cc [options] [command]
```

where the available options are:
Expand All @@ -24,9 +24,9 @@ The available commands are:

`stop` -- Stop crawler processing. The crawler service is left running but it stops pulling requests off the queue. This is the same as `start 0`.

`queue <requests...>` -- Queues the given requests for processing. The requests parameter is a list of GitHub "org" and/or "org/repo" names.
`queue <requests...>` -- Queues the given requests for processing. The requests parameter is a list of GitHub "${org}" and/or "${org}/${repo}" and/or "users/${user}" names.

`orgs <org orgs...>` -- Set the crawler's to traverse only the GitHub orgs named in the given list.
`orgs <org orgs...>` -- Set the crawlers to traverse only the GitHub orgs named in the given list.

`config` -- Dumps the crawler service's configuration to the console.

Expand All @@ -35,14 +35,24 @@ The available commands are:
A typical sequence shown in the snippet below configures the crawler with a set of tokens, configures the org filter set and then queues and starts the processing of the org.

```
> node bin/cc
> node bin/cc -i
http://localhost:3000> tokens 43984b2344ca575d0f0e097efd97#public 972bbdfe098098fa9ce082309#admin
http://localhost:3000> orgs contoso-d
http://localhost:3000> queue contoso-d
http://localhost:3000> start 5
http://localhost:3000> exit
```

Here's another example. If you want to queue up 2 users, without configuring an org, you can use this sequence. This is useful if you want to capture all events from a specific user or users.

```
> node bin/cc -i
http://localhost:3000> tokens 43984b2344ca575d0f0e097efd97#public 972bbdfe098098fa9ce082309#admin
http://localhost:3000> queue users/octocat users/microsoftopensource
http://localhost:3000> start 5
http://localhost:3000> exit
```

New commands are being added all the time. Check the help using `node bin/cc -help`.

# API
Expand Down
2 changes: 1 addition & 1 deletion bin/cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ function getCommands() {
commands
.command('queue <requests...>')
.option('-q, --queue <name>', 'The queue onto which the requests are pushed')
.description('Queue the given list of orgs and/or repos to be processed.')
.description('Queue the given list of orgs and/or repos and/or users to be processed.')
.action((requests, options) => queueRequests(requests, options));
commands
.command('start [count]')
Expand Down