diff --git a/Application.md b/Application.md index 96699c9..57be5a6 100644 --- a/Application.md +++ b/Application.md @@ -32,7 +32,7 @@ Run the following command to create a new application: ```bash gy resource app init -p project_id ``` ->If you don’t know your project ID or haven’t created a project yet, see the [[Project]] documentation. +>If you don’t know your project ID or haven’t created a project yet, see the [Projects](Project.md) documentation. #### Flags | Flag | what does it do | comment | diff --git a/Project.md b/Project.md index 319980d..afa389b 100644 --- a/Project.md +++ b/Project.md @@ -1,39 +1,98 @@ -## Create project -``` -gy resource project create --set .name="project_name" -``` -Or -```bash -gy r p c --set .name="project_name" -``` +# Projects -## List the projects : -```bash -gy resource project get -``` -Or +Projects are the foundation of resource organization in Ghaymah CLI. They provide a structured way to group and manage your resources, making it easier to maintain complex deployments and collaborate with team members. + + + +## Commands Reference + +### Creating a Project + +Create a new project with a specified name: ```bash - gy r p g - ``` +gy resource project create --set .name="my-awesome-project" +``` + +**Short form:** +```bash +gy r p c --set .name="my-awesome-project" +``` + +**Example:** +```bash +# Create a project for a web application +gy resource project create --set .name="web-app-frontend" +``` + +### Listing Projects + +View all existing projects: + +```bash +gy resource project get +``` + +**Short form:** +```bash +gy r p g +``` + + +### Updating a Project + +Modify an existing project's properties: + +```bash +gy resource project update --set .name="updated-name" +``` + +**Short form:** +```bash +gy r p u --set .name="updated-name" +``` + +**Example:** +```bash +# Update project name +gy resource project update proj_123abc --set .name="web-app-backend" +``` + +### Deleting a Project + +Remove a project and all its associated resources: + +```bash +gy resource project delete +``` + +**Short form:** +```bash +gy r p d +``` + +**Example:** +```bash +# Delete project by ID +gy resource project delete proj_123abc +``` + +> ⚠️ **Warning**: Deleting a project will permanently remove all associated resources. This action cannot be undone. + +## Best Practices + +### Naming Conventions +- Use descriptive names: `web-app-frontend`, `api-service-v2` +- Include environment indicators: `my-app-staging`, `my-app-production` +- Keep names concise but meaningful + + + +## Related Commands + +- `gy resource --help` - View all resource management commands +- `gy resource project --help` - View all project management commands + +--- + - -## Update on exiting project : -```bash -gy resource project update project_ID --set .name="new_name" - ``` -Or -```bash - gy r p u update project_ID --set .name="new_name" - ``` - - -## Delete project : -```bash - gy resource project delete project_ID - ``` -Or - -```bash - gy r p d project_ID - ``` \ No newline at end of file diff --git a/_sidebar.md b/_sidebar.md index b281adb..0eb4325 100644 --- a/_sidebar.md +++ b/_sidebar.md @@ -1,4 +1,4 @@ -- [Getting Started](Getting%20started.md) +- [Getting Started](getting-started.md) - Features diff --git a/Getting started.md b/getting-started.md similarity index 100% rename from Getting started.md rename to getting-started.md