schema-sentry-cli
v1.0.2
Published
Schema Sentry CLI is a robust command-line interface tool that provides a comprehensive solution for managing, tracking, and documenting changes in your database schemas and migration files.
Downloads
6
Maintainers
Readme
Schema Sentry CLI
Description
Schema Sentry CLI is a robust command-line interface tool that provides a comprehensive solution for managing, tracking, and documenting changes in your database schemas and migration files. It simplifies the process of versioning your database schema changes, enabling you to compare and synchronize database schemas across multiple platforms. With the added functionality of pushing changes to a remote server, Schema Sentry CLI promotes seamless collaboration and ensures your schemas are consistently up-to-date and well-documented.
Key Features
- Database Migration Tracking: Schema Sentry CLI allows you to keep a detailed record of all your database migration files and their respective versions. This ensures you always have a historical record of changes, allowing you to track progress and revert to previous versions if necessary.
- Schema Comparison and Synchronization: This feature enables you to compare database schemas across different platforms and synchronize them to ensure consistency. This is particularly useful in multi-database environments where maintaining uniformity can be challenging.
- Multi-platform Support: Schema Sentry CLI is designed to support multiple database platforms, making it a versatile tool for diverse database environments.
- Remote Server Collaboration: This feature allows you to push your schema changes to a remote server for documentation and collaboration. This ensures your team is always in sync with the latest schema changes, promoting effective team collaboration.
Getting Started
To get started with Schema Sentry CLI, follow these steps:
- Install Schema Sentry CLI globally on your machine:
npm install -g schema-sentry-cli
- Once the installation is complete, you can start working with your current project.
Usage
As of the current release, Schema Sentry CLI exclusively supports migrations from PHP-based Laravel applications.
Initialize Repository
To initialize a new repository, run the following command and follow the prompts:
schema-sentry init
Login
To login to your account, run the following command and follow the prompts:
schema-sentry login
This command will guide you through a series of prompts to log in to your account.
This command will guide you through a series of prompts to set up your new repository.
Commit Changes
When you make changes to your database schema, you can commit these changes with a descriptive message:
schema-sentry commit "Your descriptive message here"
This command will create a new commit with your changes and the provided message.
Push Changes to Remote Server
To push your committed changes to a remote server, run the following command:
schema-sentry push
This command will push your committed changes to the remote server. Make sure you're logged in before running this command.
Contributing
We welcome contributions to Schema Sentry CLI! If you'd like to contribute, please fork the repository and make changes as you'd like. Pull requests are warmly welcome.