https://github.com/allejo/beatrice

A highly experimental tool to automate generating "since" annotations for your PHP libraries
https://github.com/allejo/beatrice

documentation php phpdoc

Last synced: 3 months ago
JSON representation

A highly experimental tool to automate generating "since" annotations for your PHP libraries

• Host: GitHub
• URL: https://github.com/allejo/beatrice
• Owner: allejo
• Created: 2020-07-22T05:24:48.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T18:01:23.000Z (over 2 years ago)
• Last Synced: 2025-01-15T03:05:25.758Z (5 months ago)
• Topics: documentation, php, phpdoc
• Language: TypeScript
• Homepage:
• Size: 1.55 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
@allejo/beatrice

================

A tool to keep an inventory of when features were introduced in a library or framework

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)

[![Version](https://img.shields.io/npm/v/@allejo/beatrice.svg)](https://npmjs.org/package/@allejo/beatrice)

[![Downloads/week](https://img.shields.io/npm/dw/@allejo/beatrice.svg)](https://npmjs.org/package/@allejo/beatrice)

[![License](https://img.shields.io/npm/l/@allejo/beatrice.svg)](https://github.com/allejo/beatrice/blob/master/package.json)

* [Usage](#usage)

* [Commands](#commands)

# Usage

```sh-session

$ npm install -g @allejo/beatrice

$ beatrice COMMAND

running command...

$ beatrice (-v|--version|version)

@allejo/beatrice/0.0.0 darwin-x64 node-v10.13.0

$ beatrice --help [COMMAND]

USAGE

  $ beatrice COMMAND

...

```

# Commands

* [`beatrice help [COMMAND]`](#beatrice-help-command)

* [`beatrice inventory REPODIR SRCDIRS`](#beatrice-inventory-repodir-srcdirs)

## `beatrice help [COMMAND]`

display help for beatrice

```

USAGE

  $ beatrice help [COMMAND]

ARGUMENTS

  COMMAND  command to show help for

OPTIONS

  --all  see all commands in CLI

```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.1.0/src/commands/help.ts)_

## `beatrice inventory REPODIR SRCDIRS`

Create an inventory of an API

```

USAGE

  $ beatrice inventory REPODIR SRCDIRS

OPTIONS

  -f, --force

  -l, --lang=lang    The language to parse

  -p, --prereleases

```

_See code: [src/commands/inventory.ts](https://github.com/allejo/beatrice/blob/v0.0.0/src/commands/inventory.ts)_