Git Product home page Git Product logo

bitbucket-server-cli's Introduction

bitbucket-server-cli

CLI for interacting with Bitbucket Server

license npm ci Dependency Status devDependency Status

What is bitbucket-server-cli?

bitbucket-server-cli helps you quickly scan your Bitbucket repositories. Currently it can:

  • Audit permissions to ensure all of your repositories are configured similarly
  • Finds stale pull requests
  • Compiles statistics about pull requests

How do I install?

First thing first, let's make sure you have the necessary pre-requisites.

System Dependencies

Node

Install

  • npm install bitbucket-server-cli -g

Set environment variables

Set the following environment variables:

  • BITBUCKET_BASE_URL, ex: https://bitbucketserver.myserver.com
  • BITBUCKET_USERNAME, ex: username
  • BITBUCKET_PASSWORD, ex: password

Commands and configuration

NOTE: You will need ADMIN permissions to each project/repo you are auditing.

Global Options

Option Alias Description
bitbucket-server-cli --help bitbucket-server-cli -h Lists supported CLI options
bitbucket-server-cli --version bitbucket-server-cli -v Lists the current version number
bitbucket-server-cli --projects bitbucket-server-cli -p Comma separated list of Bitbucket project keys

Commands

bitbucket-server-cli audit-permissions

Audits permissions

Alias: ap

Permissions README

Examples bitbucket-server-cli -p "MYPROJECTKEY,MYPROJECTKEY2" -c "./permissionsConfig.json" audit-permissions

bitbucket-server-cli -p "MYPROJECTKEY,MYPROJECTKEY2" -c "./permissionsConfig.json" ap

Please see the Permissions README for additional examples.

bitbucket-server-cli stale-prs

Fetches a list of stale pull requests

Alias: sp

Stale PRs README

Examples bitbucket-server-cli -p "MYPROJECTKEY,MYPROJECTKEY2" -s "30 days" stale-prs

bitbucket-server-cli -p "MYPROJECTKEY,MYPROJECTKEY2" -s "30 days" sp

Please see the Stale PRs README for additional examples.

bitbucket-server-cli pr-stats

Fetch PRs stats

Alias: s

Pull Request Stats README

Examples bitbucket-server-cli -p "MYPROJECTKEY,MYPROJECTKEY2" -r "30 days" pr-stats

bitbucket-server-cli -p "MYPROJECTKEY,MYPROJECTKEY2" -r "30 days" s

Please see the Pull Request Stats README for additional examples.

Contributing

Please see CONTRIBUTING.md.

Release History

Please see CHANGELOG.md.

License

Copyright (c) 2017-2020 Thomas Lindner. Licensed under the MIT license.

bitbucket-server-cli's People

Contributors

shawnsparks avatar tclindner avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

bitbucket-server-cli's Issues

Line breaks in stats table output

When reporting a bug, please include:

  • A little info about your environment
    • bitbucket-server-cli version 0.2.0
    • npm version 5
    • node version 8
  • What you expected to happen
    No line breaks in the table output
  • The steps to reproduce the problem
    Run the stats command

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.