|
1 | 1 | # 8base CLI [](https://travis-ci.org/8base/cli) |
2 | 2 |
|
3 | | -[**Sign Up for 8Base**](https://app.8base.com) 🤘 [**Documentation Home**](https://docs.8base.com) 📑 [**Getting Started**](https://docs.8base.com/getting-started/quick-start) 🚀 [**8base Plans**](https://www.8base.com/pricing) |
| 3 | +[**Sign Up for 8Base**](https://app.8base.com) 🤘 [**Documentation Home**](https://docs.8base.com) 📑 [**Getting Started**](https://docs.8base.com/projects/backend/getting-started) 🚀 [**8base Plans**](https://www.8base.com/pricing) |
4 | 4 |
|
5 | 5 | The 8base Command Line Interface (CLI) makes it easy to generate custom functions and manage workspaces straight from the terminal. |
6 | 6 |
|
@@ -37,38 +37,47 @@ $ 8base login --email="my@email.com" --password="myP@ssw0rd" |
37 | 37 | Once successfully authenticated, a file will be updated at `~/.8baserc` with a JSON payload for the authenticated session. |
38 | 38 |
|
39 | 39 | ## Further Information |
40 | | -For more information about commands and configuration options, please refer the [8base CLI documentation](https://docs.8base.com/development-tools/cli). You can also learn about the different commands from the CLI by running `--help` with the package itself, or a given command. |
| 40 | +For more information about commands and configuration options, please refer the [8base CLI documentation](https://docs.8base.com/projects/backend/development-tools/cli). You can also learn about the different commands from the CLI by running `--help` with the package itself, or a given command. |
41 | 41 |
|
42 | 42 | ``` |
43 | 43 | DESCRIPTION |
44 | | - The 8base Command Line Interface is a unified tool to manage your 8base workspaces services. |
| 44 | +The 8base Command Line Interface is a unified tool to manage your 8base workspaces services. |
45 | 45 |
|
46 | 46 | USAGE |
47 | | - 8base <command> [OPTIONS] |
| 47 | +8base <command> [OPTIONS] |
48 | 48 |
|
49 | | - Use 8base command `--help` for information on a specific command. Use 8base help topics to view a list of available help topics. The synopsis for each |
50 | | - command shows it’s parameters and their usage. Optional options are shown in square brackets. |
| 49 | +Use 8base command `--help` for information on a specific command. Use 8base help topics to view a list of |
| 50 | +available help topics. The synopsis for each command shows its parameters and their usage. Optional options |
| 51 | +are shown in square brackets. |
51 | 52 |
|
52 | 53 | COMMANDS |
53 | | - 8base configure Allows you to select a default workspace and retrieve the API endpoint URL. |
54 | | - 8base deploy Deploys project in current directory to 8base using 8base.yml config file. To use this command, you must be in the root directory |
55 | | - of your 8base project. |
56 | | - 8base describe [name] Describes your 8base project’s functions and their types through 8base.yml file. |
57 | | - 8base export Export current workspace data schema |
58 | | - 8base generate <command> Generator for server and client side resources [aliases: g] |
59 | | - 8base import Import 8base schema file and data to the current - or specified - workspace. |
60 | | - 8base init Initializes a new project with example directory structure and custom functions. |
61 | | - 8base invoke [name] Invokes a custom function in the production workspace. |
62 | | - 8base invoke-local [name] Invokes the custom function in the local development workspace. |
63 | | - 8base login Authenticates the command line user by letting them log into an 8base account. |
64 | | - 8base logout Clears local login credentials and invalidates API session. |
65 | | - 8base logs [name] Show logs for the function(s). |
66 | | - 8base package Package 8base application without deploying it. |
| 54 | + 8base backup <command> Backup commands. |
| 55 | + 8base configure Allows you to select a default workspace and retrieve the API endpoint URL. |
| 56 | + 8base deploy Deploys project described in 8base.yml config file from your current local |
| 57 | + directory to 8base server. You must be in the root directory of your local |
| 58 | + 8base project to use this command. |
| 59 | + 8base describe [name] Describes your 8base project’s functions and their types through 8base.yml |
| 60 | + file. |
| 61 | + 8base environment <command> Environment commands. |
| 62 | + 8base export Exports current workspace data schema |
| 63 | + 8base generate <command> Generator for server and client side resources [aliases: g] |
| 64 | + 8base import Imports 8base schema file and data to the current - or specified - workspace. |
| 65 | + 8base init [name] Initializes a new project with example directory structure and custom |
| 66 | + functions. |
| 67 | + 8base invoke <name> Invokes a custom function in the production workspace. |
| 68 | + 8base invoke-local <name> Invokes the custom function in the local development workspace. |
| 69 | + 8base login Authenticates the command line user by letting them log into an 8base account. |
| 70 | + 8base logout Clears local login credentials and invalidates API session. |
| 71 | + 8base logs [name] Shows logs for the functions or migrations. |
| 72 | + 8base migration <command> Migration commands. |
| 73 | + 8base package Package 8base application without deploying it. |
| 74 | + 8base project <command> Project-related commands. |
| 75 | + 8base whoami Displays the current authenticated user. |
67 | 76 |
|
68 | 77 | OPTIONS |
69 | | - --version, -v Show version number [boolean] |
70 | | - --debug, -d Turn on debug logs [boolean] |
71 | | - --help, -h Show help |
| 78 | + -v, --version Show version number [boolean] |
| 79 | + -d, --debug Turn on debug logs [boolean] |
| 80 | + -h, --help Show help [boolean] |
72 | 81 | ``` |
73 | 82 |
|
74 | 83 | ## Contributing |
|
0 commit comments