Download the PHP package aichadigital/bookstack-sync without Composer

On this page you can find all versions of the php package aichadigital/bookstack-sync. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of aichadigital/bookstack-sync

Informations about the package bookstack-sync

BookStack Sync

Latest Version on Packagist Total Downloads GitHub Tests Action Status GitHub Code Style Action Status PHPStan Level 8 codecov PHP Version Laravel Version

A Laravel package for synchronizing Markdown documentation with BookStack wiki. Perfect for keeping your project documentation in sync between your codebase and BookStack.

Features

Version Compatibility

Version PHP Laravel Branch
2.x ^8.4 12, 13 main
1.x ^8.2 10, 11, 12 laravel-12

Requirements

Installation

Publish the configuration file:

Configuration

Add these variables to your .env file:

Alternative variable names are also supported for compatibility:

Usage

Artisan Commands

Check Connection Status

Push Local Files to BookStack

Pull from BookStack to Local Files

Export Content

Search

Sync Wiki Structure to Local Cache

Query Local Cache

Programmatic Usage

Bookmark Conversion

The package automatically handles the conversion between AI-generated bookmark formats and BookStack's URL-encoded format:

Direct Parser Usage

Markdown Frontmatter

You can use YAML frontmatter in your Markdown files to specify metadata:

Supported frontmatter fields:

Sync Configuration

Configure sync behavior in config/bookstack-sync.php:

Local Database Configuration

The package includes a local SQLite cache to reduce API calls and enable change detection:

Environment Variables

How It Works

  1. Run php artisan bookstack:sync to populate the local cache
  2. The cache stores all shelves, books, chapters, and pages with their metadata
  3. During push/pull operations, the package uses content hashes to skip unchanged files
  4. Deleted items in BookStack are marked with is_deleted flag for tracking

Spanish Character Encoding Reference

Character URL Encoded
á %C3%A1
é %C3%A9
í %C3%AD
ó %C3%B3
ú %C3%BA
ñ %C3%B1
ü %C3%BC
ç %C3%A7

Testing

To run tests against your actual BookStack instance, copy .env.example to .env and configure your credentials:

API Reference

This package uses the BookStack REST API. Key endpoints used:

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

Special thanks to:

Trademark Notice: BookStack® is a registered trademark of Daniel Brown. This package is not affiliated with, endorsed by, or sponsored by BookStack or Daniel Brown.

License

This package is licensed under the GNU Affero General Public License v3.0 or later (AGPL-3.0-or-later). Please see License File for more information.

All versions of bookstack-sync with dependencies

PHP Build Version
Package Version
Requires php Version ^8.4
spatie/laravel-package-tools Version ^1.16||^2.0
illuminate/contracts Version ^12.0||^13.0
illuminate/support Version ^12.0||^13.0
illuminate/http Version ^12.0||^13.0
guzzlehttp/guzzle Version ^7.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package aichadigital/bookstack-sync contains the following files

Loading the files please wait ...