Project Management

Project Management with Hawiyat CLI

The Hawiyat CLI provides a robust set of commands for managing your projects. From creation to deployment, these commands give you full control over your project lifecycle.

Prerequisites

Before using project commands, ensure:

• You have Hawiyat CLI installed
• You are authenticated (hawiyat auth login)
• You have necessary permissions in your organization

Available Commands

Create Project

hawiyat project create [options]

Create a new project in your Hawiyat workspace.

Options:

• --name <name> - Project name (required)
• --description <desc> - Project description
• --template <template> - Initialize with a template
• --private - Create a private project
• --org <organization> - Create in specific organization

Example:

hawiyat project create --name my-awesome-app --description "My new application" --template next.js

Project Information

hawiyat project info [project-name]

Display detailed information about a specific project.

Output includes:

• Project configuration
• Environment variables
• Deployment status
• Resource usage
• Connected services

List Projects

hawiyat project list [options]

List all projects you have access to.

Options:

• --format <format> - Output format (table|json|yaml)
• --status <status> - Filter by status
• --org <organization> - Filter by organization
• --limit <number> - Limit number of results

Update Project

hawiyat project update [project-name] [options]

Update project settings and configuration.

Options:

• --name <new-name> - New project name
• --description <desc> - Update description
• --env <key=value> - Set environment variables
• --scale <instances> - Update scaling configuration

Delete Project

hawiyat project delete [project-name] [--force]

Remove a project and all associated resources.

Options:

• --force - Skip confirmation prompt
• --keep-domain - Preserve custom domains
• --backup - Create backup before deletion

Project Logs

hawiyat project logs [project-name] [options]

View project logs in real-time.

Options:

• --tail - Follow log output
• --since <time> - Show logs since timestamp
• --service <name> - Filter by service
• --level <level> - Filter by log level

Project Configuration

Projects can be configured using hawiyat.config.js:

module.exports = {
  name: 'my-project',
  type: 'web',
  env: {
    NODE_ENV: 'production'
  },
  scale: {
    min: 1,
    max: 5,
    auto: true
  },
  build: {
    command: 'npm run build',
    output: 'dist'
  }
};

Best Practices

1. Project Naming

   • Use lowercase letters, numbers, and hyphens
   • Keep names short but descriptive
   • Avoid special characters

2. Environment Management

   • Use .env files for local development
   • Set production secrets via CLI or dashboard
   • Regularly rotate sensitive credentials

3. Resource Optimization

   • Monitor resource usage with hawiyat project stats
   • Set appropriate scaling parameters
   • Clean up unused projects

Related Commands

• hawiyat deploy - Deploy your project
• hawiyat env - Manage environment variables
• hawiyat domains - Configure custom domains

Troubleshooting

If you encounter issues:

1. Verify your authentication status:

hawiyat auth status

2. Check project status:

hawiyat project status [project-name]

3. View detailed logs:

hawiyat project logs [project-name] --debug

For more assistance, visit our support portal or join our Discord community.