enact-cli 1.0.0

package/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) {{ year }} {{ organization }}
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
+OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,154 @@
+## Development
+
+This section provides instructions for setting up your development environment and contributing to the Enact CLI.
+
+### Prerequisites
+
+* **Bun:** This project is built using Bun. Ensure you have Bun installed on your system. You can find installation instructions on the [official Bun website](https://bun.sh/).
+* **Node.js (optional):** While Bun is the primary runtime, having Node.js installed can be helpful for certain development tools. You can download it from [nodejs.org](https://nodejs.org/).
+
+### Getting Started
+
+1. **Clone the repository:**
+   ```bash
+   git clone <repository-url>
+   cd enact-cli
+   ```
+
+2. **Install dependencies:**
+   ```bash
+   bun install
+   ```
+   This command will install all the necessary dependencies listed in your `package.json` file.
+
+3. **Build and install locally:**
+   ```bash
+   chmod +x deploy
+   ./deploy
+   ```
+   This creates a standalone binary and installs it to your PATH so you can use `enact` commands globally.
+
+### Development Workflow
+
+1. **Make changes:** Create a new branch for your feature or bug fix:
+   ```bash
+   git checkout -b feature/your-feature-name
+   # or
+   git checkout -b bugfix/your-bug-fix
+   ```
+   Make your code changes in the `src/` directory.
+
+2. **Test during development:** You can run the CLI directly without building:
+   ```bash
+   bun src/index.ts <command> [arguments] [options]
+   
+   # Examples:
+   bun src/index.ts --help
+   bun src/index.ts publish
+   bun src/index.ts create my-tool
+   ```
+
+3. **Build and test the binary:** After making changes, rebuild and test:
+   ```bash
+   ./deploy
+   enact --version  # Test the installed binary
+   ```
+
+4. **Run tests (when available):**
+   ```bash
+   bun test
+   ```
+
+5. **Lint and format your code:**
+   ```bash
+   bun run lint     # Check for issues
+   bun run format   # Format code
+   ```
+
+6. **Commit your changes:**
+   ```bash
+   git add .
+   git commit -m "feat: Add your feature description"
+   ```
+   Follow [conventional commit](https://conventionalcommits.org/) guidelines for better collaboration.
+
+7. **Push and create PR:**
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+   Then create a pull request on GitHub.
+
+### Development Commands
+
+| Command | Description |
+|---------|-------------|
+| `bun src/index.ts` | Run CLI directly from source |
+| `./deploy` | Build and install binary to PATH |
+| `bun test` | Run test suite |
+| `bun run lint` | Check code style |
+| `bun run format` | Format code |
+
+### Project Structure
+
+```
+src/
+├── index.ts           # CLI entry point
+├── commands/          # Command implementations
+│   ├── publish.ts     # Publish command
+│   ├── create.ts      # Create command
+│   └── remote.ts      # Remote management
+└── utils/             # Shared utilities
+    ├── help.ts        # Help system
+    ├── logger.ts      # Logging utilities
+    ├── config.ts      # Configuration management
+    └── version.ts     # Version display
+```
+
+### Building for Release
+
+To build standalone binaries for distribution:
+
+```bash
+# Single platform (current system)
+bun build src/index.ts --compile --outfile=dist/enact
+
+# Multiple platforms
+bun build src/index.ts --compile --target=bun-linux-x64 --outfile=dist/enact-linux
+bun build src/index.ts --compile --target=bun-darwin-x64 --outfile=dist/enact-macos  
+bun build src/index.ts --compile --target=bun-windows-x64 --outfile=dist/enact.exe
+```
+
+### Debugging
+
+For debugging during development:
+
+```bash
+# Run with debug output
+DEBUG=* bun src/index.ts <command>
+
+# Or set log level in code
+# See src/utils/logger.ts for LogLevel options
+```
+
+### Contributing Guidelines
+
+- Follow TypeScript best practices
+- Add tests for new features
+- Update documentation for any CLI changes
+- Use conventional commit messages
+- Ensure the binary builds successfully before submitting PRs
+
+### Troubleshooting
+
+**Binary not found after build:**
+- Ensure `~/.local/bin` is in your PATH
+- Try restarting your terminal
+- Run `source ~/.bashrc` (or your shell profile)
+
+**Permission denied:**
+- Make sure deploy script is executable: `chmod +x deploy`
+- Check that `~/.local/bin` has write permissions
+
+**Bun build fails:**
+- Ensure you're using a recent version of Bun (`bun --version`)
+- Check for TypeScript errors: `bun check src/index.ts`