diff --git a/README.md b/README.md index 6e0a78f2aa..12ea11cca2 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,38 @@ It is inspired by RDBMS and Git, and attempts to blend concepts about both in a We also built [DoltHub](https://www.dolthub.com), a cloud based storage solution for hosting Dolt databases, that facilitates collaborative management of databases. We host public data for free! +## Dolt CLI + +``` +timsehn$ dolt +Valid commands for dolt are + init - Create an empty Dolt data repository. + status - Show the working tree status. + add - Add table changes to the list of staged table changes. + reset - Remove table changes from the list of staged table changes. + commit - Record changes to the repository. + sql - Run a SQL query against tables in repository. + sql-server - Starts a MySQL-compatible server. + log - Show commit logs. + diff - Diff a table. + merge - Merge a branch. + branch - Create, list, edit, delete branches. + checkout - Checkout a branch or overwrite a table from HEAD. + remote - Manage set of tracked repositories. + push - Push to a dolt remote. + pull - Fetch from a dolt remote data repository and merge. + fetch - Update the database from a remote data repository. + clone - Clone from a remote data repository. + creds - Commands for managing credentials. + login - Login to a dolt remote host. + version - Displays the current Dolt cli version. + config - Dolt configuration. + ls - List tables in the working set. + schema - Display the schema for table(s) + table - Commands for creating, reading, updating, and deleting tables. + conflicts - Commands for viewing and resolving merge conflicts. +``` + ## Installation Obtain the appropriate archive for your operating system under [releases](https://github.com/liquidata-inc/dolt/releases):