From 145fa7b95bb7b9828ce6aa8d3c24f27cfa0c5546 Mon Sep 17 00:00:00 2001 From: Pascal Date: Thu, 19 Mar 2020 16:04:41 +0100 Subject: [PATCH] docs: updated aliases --- plugins/firebase/README.md | 69 ++++++++++++++++++++++++-------------- 1 file changed, 43 insertions(+), 26 deletions(-) diff --git a/plugins/firebase/README.md b/plugins/firebase/README.md index 792af12a2..8b6a4d1a7 100644 --- a/plugins/firebase/README.md +++ b/plugins/firebase/README.md @@ -11,35 +11,52 @@ plugins=(... firebase) ## Aliases Reference: https://firebase.google.com/docs/cli#admin-commands -(Only implemented often used commands.) -```zsh -### INIT (FBI) - https://firebase.google.com/docs/cli#initialize_a_firebase_project -alias fbi="firebase init" # Initialize a Firebase project +### fbi: [firebase init](https://firebase.google.com/docs/cli#initialize_a_firebase_project) -# USE (FBU) - https://firebase.google.com/docs/cli#add_alias -alias fbu="firebase use" # Use a firebase project -alias fbua="firebase use -add" # Add and use a firebase project -# SERVE (FBS) - https://firebase.google.com/docs/cli#test-locally -alias fbs="firebase serve" # Serve a Firebase project locally -alias fbs0="firebase serve --host 0.0.0.0" # Serve a Firebase projeczt on 0.0.0.0 -alias fbsh="firebase serve --only hosting" # Serve a Firebase project locally () -alias fbsf="firebase serve --only functions" # Serve a Firebase project locally () -# DEPLOY (FBD) - https://firebase.google.com/docs/cli#partial_deploys -alias fbd="firebase deploy" # Deploy Firebase (Complete) -alias fbdh="firebase deploy --only hosting" # Deploy Firebase Hosting -alias fbdd="firebase deploy --only database" # Deploy Firebase Realtime Database -alias fbds="firebase deploy --only storage" # Deploy Firebase Storage -alias fbdfs="firebase deploy --only firestore" # Deploy Firebase Firestore -alias fbdfsr="firebase deploy --only firestore:rules" # Deploy Firebase Firestore (only Rules) -alias fbdfsi="firebase deploy --only firestore:indexes" # Deploy Firebase Firestore (only Indexes) -alias fbdfu="firebase deploy --only functions" # Deploy Firebase Functions +| Alias | Command | Description | +| :---- | :----------------------------------------- | :--------------------------- | +| fbi | `firebase init` | Initialize a Firebase project | -# FUNCTIONS (FBF) - https://firebase.google.com/docs/cli#delete_functions -alias fbfd="firebase functions:delete" # Delete Firebase Function +### fbi: [firebase use](https://firebase.google.com/docs/cli#add_alias) -# MISC (FBx) -alias fbp="firebase projects:list" # List all projects -``` \ No newline at end of file +| Alias | Command | Description | +| :---- | :----------------------------------------- | :--------------------------- | +| fbu | `firebase use` | Use a firebase project | +| fbua | `firebase use -add` | Add and use a firebase project | + +### fbs: [firebase serve](https://firebase.google.com/docs/cli#test-locally) + +| Alias | Command | Description | +| :---- | :----------------------------------------- | :--------------------------- | +| fbs | `firebase serve` | Serve a Firebase project locally | +| fbs0 | `firebase serve --host 0.0.0.0` | Serve a Firebase projeczt on 0.0.0.0 | +| fbsh | `firebase serve --only hosting` | Serve a Firebase project locally (Only Hosting) | +| fbsf | `firebase serve --only functions` | Serve a Firebase project locally (only Functions) | + +#### fbd [firebase deploy](https://firebase.google.com/docs/cli#partial_deploys) + +| Alias | Command | Description | +| :---- | :----------------------------------------- | :--------------------------- | +| fbd | `firebase deploy` | Deploy Firebase (Complete) | +| fbdh | `firebase deploy --only hosting` | Deploy Firebase Hosting | +| fbdd | `firebase deploy --only database` | Deploy Firebase Realtime Database | +| fbds | `firebase deploy --only storage` | Deploy Firebase Storage | +| fbdfs | `firebase deploy --only firestore` | Deploy Firebase Firestore | +| fbdfsr | `firebase deploy --only firestore:rules` | Deploy Firebase Firestore (only Rules) | +| fbdfsi | `firebase deploy --only firestore:indexes` | Deploy Firebase Firestore (only Indexes) | +| fbdfu | `firebase deploy --only functions` | Deploy Firebase Functions | + +#### fbf - [firebase functions](https://firebase.google.com/docs/cli#delete_functions) + +| Alias | Command | Description | +| :---- | :----------------------------------------- | :--------------------------- | +| fbfd | `firebase functions:delete` | Delete Firebase Function | + +#### fb... - Misc + +| Alias | Command | Description | +| :---- | :----------------------------------------- | :--------------------------- | +| fbp | `firebase projects:list` | List all projects | \ No newline at end of file