Geting started, Help & Usage

Octosuite has been installed succesfully! To launch it, just run octosuite in your terminal, that should open a session.

Upon launch, Octosuite will attempt to check for updates and create 2 directories (.octosuite-logs, octosuite-output) if they don't already exist.

• .octosuite-logs: is where the logs of each session will be kept.
• octosuite-output: is where csv files will be kept.

Now it's time to start investigating. Octosuite features work with subcommands. The following are basic commands that will get you started.

Basic commands

Command	Description
ls	List contents of the current working directory
cd	Change current working directory
help	Help menu
exit	Close session
clear	Clear screen
about	Program info

---

The following are subcommands for the help command. This means that you can use other commands together with help.

The syntax for subcommands is [core command]:[subcommand]

Example

To list all user investigation commands, you use the following command:

help:user

Help subcommands

Command	Description
csv	List all csv management commands
org	List all organization investigation commands
logs	List all logs management commands
repo	List all repository investigation commands
user	List all user investigation commands
search	List all target discovery commands

CLI

Octosuite can also be used with command line arguments, to do so, simply run octosuite-cli --help in your terminal, to see all available flags and options.

usage: 
    Basic Usage
    ===========

        Get User Profile Info
        ---------------------
        octosuite-cli --initialise user-profile --username <username>


        Get User Repos
        --------------
        octosuite-cli --initialise user-repos --username <username>


        Get Organisation Profile Info
        -----------------------------
        octosuite-cli --initialise org-profile --organisation <organisation name>


        Get Organisation Repos
        -----------------------------
        octosuite-cli --initialise org-repos --organisation <organisation name>

        
        Get Repository Profile Info
        ---------------------------
        octosuite-cli --initialise repo-profile --username <username> --repository <repository name>


        Get Repository Forks
        --------------------
        octosuite-cli --initialise repo-forks --username <username> --repository <repository name>
        
    
    
    Searching
    =========

        Search Users
        ------------
        octosuite-cli --initialise users-search --query <query>

        
        Search Issues
        -------------
        octosuite-cli --initialise issues-search --query <query>

        
        Search Commits
        --------------
        octosuite-cli --initialise commits-search --query <query>
        

        Search Topics
        -------------
        octosuite-cli --initialise topics-search --query <query>
        

        Search Repositories
        -------------------
        octosuite-cli --initialise repos-search --query <query>



    Log Management
    ==============

        View logs
        ---------
        octosuite-cli --initialise view-logs


        Read log
        --------
        octosuite-cli --initialise read-log --file <log filename>


        Delete log
        ----------
        octosuite-cli --initialise delete-log --file <log filename>


        Clear logs
        ----------
        octosuite-cli --initialise clear-logs



    CSV Management
    ==============

        View CSV
        ---------
        octosuite-cli --initialise view-csv


        Read A Specified CSV File
        -------------------------
        octosuite-cli --initialise read-csv --file <csv filename>


        Delete CSV
        ----------
        octosuite-cli --initialise delete-csv --file <csv filename>


        Clear All CSV Files
        -------------------
        octosuite-cli --initialise clear-csv
        

octosuite/octosuite-cli: An all-in-one GitHub open-source intelligence framework. — by Richard Mwewa (https://about.me/rly0nheart)

options:
  -h, --help            show this help message and exit
  -i, --initialise, --initialize {user-email,
                                  user-profile,
                                  user-repos,
                                  user-gists,
                                  user-orgs,
                                  user-events,
                                  user-subscriptions,
                                  user-following,
                                  user-followers,
                                  user-follows,
                                  org-profile,
                                  org-repos,
                                  org-events,
                                  is-org-member,
                                  repo-profile,
                                  repo-contributors,
                                  repo-stargazers,
                                  repo-forks,
                                  repo-issues,
                                  repo-releases,
                                  repo-path-contents,
                                  users-search,
                                  issues-search,
                                  commits-search,
                                  topics-search,
                                  repos-search,
                                  view-logs,
                                  read-log,
                                  delete-log,
                                  clear-logs,
                                  view-csv,
                                  read-csv,
                                  delete-csv,
                                  clear-csv,
                                  about}            
                        init method
  -a, --about           show program's about information
  -c, --colours, --colors
                        pass to run octosuite-cli with colours enabled
  -csv, --log-to-csv    log output to a csv file
  -f FILE, --file FILE  filename (used with logs/csv management arguments)
  -l LIMIT, --limit LIMIT
                        output limit (used with methods that return results in bulk) (default: 10)
  -o ORGANISATION, --organisation ORGANISATION, --organization ORGANISATION
                        organisation name
  -pn PATH_NAME, --path-name PATH_NAME
                        path name (used with repo-path-contents)
  -q QUERY, --query QUERY
                        query (used with search arguments)
  -r REPOSITORY, --repository REPOSITORY
                        repository name
  -u USERNAME, --username USERNAME
                        username
  -ub USERNAME_B, --username-b USERNAME_B
                        username-b (used with user-follows)
  -v, --version         show program's version number and exit