dbdoc

Database documentation generator utility. currently supports MySql 5.1

Install

npm install -g dbdoc

Dependencies

commander - https://github.com/visionmedia/commander.js/
mysql - https://github.com/felixge/node-mysql

Usage

dbdoc [options]

Options:

    --help                  output usage information
    -V, --version           output the version number
    -h, --host [value]      DB host address
    -u, --user [value]      DB username
    -p, --pass [value]      DB password
    -d, --database [value]  DB name
    -o, --out [path]        [optional] output folder, default to ./
    -s, --style [path]      [optional] path to style(css) file

Author

Itzik Paz https://github.com/spideron

Copyright and license

Modular Patterns Ltd. (c) 2012 All Rights Reserved

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License at:

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.