TimeWarpRooTools 1.0.0-beta.2

TimeWarp Roo Tools (roo)

TimeWarp Roo Tools is a command-line toolkit for TimeWarp development workflows. This repository serves as a placeholder for future CLI tools. Built with .NET 9.0, it's designed to streamline workflows for developers working with TimeWarp projects. This project is authored by Steven T. Cramer.

Future Tools (TBD)

This repository will be used for developing TimeWarp development tools. Currently, it serves as a placeholder for future CLI tools that will enhance the TimeWarp development experience.

Prerequisites

• .NET SDK 9.0: Required to install and run the tool.
• Visual Studio Code: Optional, for using the timewarp-roo extension to automate setup.

Installation

Option 1: Via VS Code Extension (Recommended)

The easiest way to install roo is with the timewarp-roo VS Code extension, which handles both the .NET SDK and tool installation.

1. Install the C# Dev Kit Extension:

   • Open VS Code.
   • Go to Extensions (Ctrl+Shift+X or Cmd+Shift+X on macOS).
   • Search for C# Dev Kit (published by Microsoft) and install it.
   • Follow the prompts to install the .NET SDK 9.0 if it's not already present.

2. Install the timewarp-roo Extension:

   • In VS Code, install the timewarp-roo extension from the Marketplace (once published) or sideload it:

     code --install-extension path/to/timewarp-roo-0.0.1.vsix
     

   • On first activation, timewarp-roo will install roo globally using dotnet tool install -g TimeWarpRooTools.

3. Verify Installation:

   • Open a terminal (in VS Code or elsewhere) and run:

     roo --version
     

   • Expected output: 1.0.0

Option 2: Manual Installation

If you prefer not to use VS Code or the extension:

1. Install .NET SDK 9.0:

   • Download and install from dotnet.microsoft.com.

2. Install the Tool:

   • Run the following command to install roo globally from NuGet:

     dotnet tool install -g TimeWarpRooTools
     

   • Or, if you've built it locally:

     cd Tools/TimewarpRooTools
     dotnet pack
     dotnet tool install --add-source ./nupkg -g TimeWarpRooTools
     

3. Verify Installation:

   • Run:

     roo --version
     

   • Expected output: 1.0.0

Commands

• roo --version:

  • Displays the current version of the tool (e.g., 1.0.0).

• roo --check-update:

  • Forces a check for the latest version on NuGet and updates the local cache.

• roo --no-check:

  • Skips the automatic version check (useful offline).

Building from Source

1. Clone the Repository:

   git clone https://github.com/TimeWarpEngineering/timewarp-roo.git
   cd timewarp-roo/Tools/TimewarpRooTools
   

2. Build and Run:

   dotnet build
   dotnet run -- --version
   

3. Pack as a Tool:

   dotnet pack
   

Troubleshooting

• .NET 9.0 Not Found: If the SDK isn't available, edit TimeWarpRooTools.csproj to use <TargetFramework>net8.0</TargetFramework> and retry.
• Installation Fails: Ensure you have internet access and the correct .NET SDK version installed (dotnet --list-sdks).
• Command Not Found: Verify roo is in your PATH after installation (~/.dotnet/tools on Unix-like systems, %USERPROFILE%\.dotnet\tools on Windows).

Contributing

Contributions are welcome! Fork the repo, make changes, and submit a pull request to TimeWarpEngineering/timewarp-roo.

License

This project is licensed under the MIT License. See LICENSE for details.

Author

• Steven T. Cramer