Code Monkey home page Code Monkey logo

psbookstack's Introduction

BookStack PowerShell Module

Description

This module talks to the BookStack API to help in managing your installation.

The API can be located at https://<DNS Name or IP>/api

Download And Import

Download all the files into your PowerShell module path (usually C:\Program Files\WindowsPowerShell\Modules) and import it

Import-Module -Name 'psBookStack'

Basic Usage

To start using the module, you need to authenticate with your BookStack installation:

Connect-BookStackAPI -Url '<DNS Name or IP>' -Credential <PSCredential>

Connect-BookStackAPI -Url '<DNS Name or IP>' -Token 'abcde:12345'

Once connected, you can start using any of the other commands. For example, to list all shelves in your environment, use Get-BsShelf

Comment Based Help

Every command has its own comment based help, so there should be no issues with getting information for the commands.

Most of the help comes from the API itself.

Bugs / Issues

If you find any bugs or issues please let me know and I'll try to fix them.

psbookstack's People

Contributors

my-random-thoughts avatar

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.