Introduction
Spec-Up-T offers three distinct methods for creating and editing your specifications. Each method has different strengths, so you can choose the one that best fits your needs and technical comfort level.
The Three Methods
1. Local Installation (Command Line)
Install Spec-Up-T on your computer and work locally using the command line.
Best for:
- Developers and technical users
- Fast, responsive editing and rendering
- Offline work
- Full control over the development environment
You'll need:
- Node.js and Git installed on your computer
- Familiarity with command line tools
- A local text editor (like Visual Studio Code)
Learn more about Local Installation →
2. GitHub Web-Based
Use GitHub Actions to run Spec-Up-T workflows and GitHub's built-in web editor for editing files - all through your web browser.
Best for:
- Quick setup without installing software
- Occasional contributors
- Simple edits and updates
- Users who prefer browser-based work
You'll need:
- A GitHub account
- A web browser
- Basic familiarity with GitHub's interface
Note: GitHub Actions run on GitHub's servers, which can take several minutes to start up and execute.
Learn more about GitHub Web-Based →
3. Spec-Up-T Editor
Use our dedicated web-based Spec-Up-T Editor application - a specialized tool designed specifically for specification development.
Best for:
- Content authors who want an intuitive interface
- Visual file organization (drag-and-drop)
- Managing external specification references
- Teams needing health checks and diagnostics
- Users who want more features than GitHub's basic editor
You'll need:
- A GitHub account
- A web browser
- A GitHub Personal Access Token (we'll show you how)
Key features:
- Visual file management with drag-and-drop reordering
- Integrated markdown editor with live preview
- External specifications management
- Health check diagnostics
- Terms and definitions management
🌐 Launch the Spec-Up-T Web Editor | Learn more about the Editor →
Comparison Table
| Feature | Local Installation | GitHub Web-Based | Spec-Up-T Editor |
|---|---|---|---|
| Installation Required | ✅ Yes (Node.js, Git) | ❌ No | ❌ No |
| Technical Knowledge | Higher | Lower | Lower |
| Editing Speed | Very Fast | Slower (GitHub Actions) | Medium |
| Works Offline | ✅ Yes | ❌ No | ❌ No |
| Visual File Organization | ❌ No | ❌ No | ✅ Yes |
| Health Checks | ✅ Yes (CLI) | ❌ No | ✅ Yes (Visual) |
| External Specs Management | Manual (CLI) | Manual (CLI) | ✅ Visual Interface |
| Live Preview | ✅ Yes | Limited | ✅ Yes |
| Drag-and-Drop File Ordering | ❌ No | ❌ No | ✅ Yes |
Which Method Should You Choose?
- Choose Local Installation if you're comfortable with command line tools and want the fastest, most powerful experience
- Choose GitHub Web-Based if you want the simplest setup and don't mind slower execution times
- Choose Spec-Up-T Editor if you want a user-friendly web interface with advanced specification management features
You can also use multiple methods for the same project! For example, use Local Installation for heavy development work and the Spec-Up-T Editor for quick edits or visual file organization.