Command Line Interface¶
quickci offers two main CLI commands:
statusshows the current status of your projects on one or more CI services;
configcreates or updates the configuration file needed.
This command retrieves the status of your projects on one or more CI services (
master branch by default).
If issued as
quickci status, will retrieve these information for all the CI services for which an authentication token is available in the config file:
$ quickci status CircleCI (master branch) project1 -> success project2 -> failed Travis CI (master branch) project1 -> passed project2 -> passed AppVeyor (master branch) project1 -> passed Buddy (master branch) project2 -> enqueued Drone CI (master branch) project1 -> success
If you want to monitor one specific branch of your repositories (suppose you have many repos with a dedicated
dev branch for development), you can easily add the
--branch <branch_name> option:
$ quickci status --branch dev
--branch option is not provided, the build status of the
master branch will be retrieved by default.
If you want to check one specific repository, you can provide the
--repo <reponame> option:
$ quickci status --repo my_repo
It is obviously possible to combine the
--branch options to check a given branch of a specific repository.
It is also possible to check a specific service using subcommands of
$ quickci status travis $ quickci status circle $ quickci status appveyor $ quickci status buddy $ quickci status drone
These subcommands also accept the
$ quickci status travis --branch master $ quickci status circle --branch feature1 --repo my_repo $ quickci status drone --branch new_feature --repo my_other_repo
If you have not set up a config file, you can still retrieve information from CI services providing their authentication token right into the command:
$ quickci status travis --token <TRAVIS_CI_TOKEN>
This command allows to create a config file for
quickci, or update it if a config file is already available.
create command will create a brand new config file, located in
$ quickci config create
If a config file is already present at that location, you will be prompted to confirm your desire to clear it and create a new one. New config files fill the authentication tokens with a temporary string, which you will need to update with proper tokens.
update command allows to update one of the authentication tokens in the existing config file:
$ quickci config update <CIservice> <token>
show command will show all the stored authentication tokens:
$ quickci config show